Class: Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataform/v1beta1/dataform.rb

Overview

Represents a single action in a workflow invocation.

Defined Under Namespace

Modules: State Classes: BigQueryAction, DataPreparationAction, NotebookAction

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_action ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction (readonly)

Returns Output only. The workflow action's bigquery action details.

Note: The following fields are mutually exclusive: bigquery_action, notebook_action, data_preparation_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#canonical_target ⇒ ::Google::Cloud::Dataform::V1beta1::Target (readonly)

Returns Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#data_preparation_action ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction (readonly)

Returns Output only. The workflow action's data preparation action details.

Note: The following fields are mutually exclusive: data_preparation_action, bigquery_action, notebook_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#failure_reason ⇒ ::String (readonly)

Returns Output only. If and only if action's state is FAILED a failure reason is set.

Returns:

  • (::String) —

    Output only. If and only if action's state is FAILED a failure reason is set.



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#internal_metadata ⇒ ::String (readonly)

Returns Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Returns:

  • (::String) —

    Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#invocation_timing ⇒ ::Google::Type::Interval (readonly)

Returns Output only. This action's timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.

Returns:

  • (::Google::Type::Interval) —

    Output only. This action's timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#notebook_action ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::NotebookAction (readonly)

Returns Output only. The workflow action's notebook action details.

Note: The following fields are mutually exclusive: notebook_action, bigquery_action, data_preparation_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#state ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::State (readonly)

Returns Output only. This action's current state.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end

#target ⇒ ::Google::Cloud::Dataform::V1beta1::Target (readonly)

Returns Output only. This action's identifier. Unique within the workflow invocation.

Returns:



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2450

class WorkflowInvocationAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a workflow action that will run against BigQuery.
  # @!attribute [r] sql_script
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class BigQueryAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run against a Notebook runtime.
  # @!attribute [r] contents
  #   @return [::String]
  #     Output only. The code contents of a Notebook to be run.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the Vertex job that executed the notebook in
  #     contents and also the ID used for the outputs created in Google Cloud
  #     Storage buckets. Only set once the job has started to run.
  class NotebookAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a workflow action that will run a Data Preparation.
  # @!attribute [r] contents_yaml
  #   @return [::String]
  #     Output only. YAML representing the contents of the data preparation.
  #     Can be used to show the customer what the input was to their workflow.
  #
  #     Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] contents_sql
  #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
  #     SQL definition for a Data Preparation. Contains a SQL query and
  #     additional context information.
  #
  #     Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [r] generated_sql
  #   @return [::String]
  #     Output only. The generated BigQuery SQL script that will be executed. For
  #     reference only.
  # @!attribute [r] job_id
  #   @return [::String]
  #     Output only. The ID of the BigQuery job that executed the SQL in
  #     sql_script. Only set once the job has started to run.
  class DataPreparationAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Definition of a SQL Data Preparation
    # @!attribute [rw] query
    #   @return [::String]
    #     The SQL query representing the data preparation steps. Formatted as a
    #     Pipe SQL query statement.
    # @!attribute [rw] error_table
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load_config
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
    #     Load configuration.
    class ActionSqlDefinition
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Error table information, used to write error data into a BigQuery
    # table.
    # @!attribute [rw] target
    #   @return [::Google::Cloud::Dataform::V1beta1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ActionErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simplified load configuration for actions
    # @!attribute [rw] replace
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Replace destination table
    #
    #     Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] append
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
    #     Append into destination table
    #
    #     Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] maximum
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value exceeds the previous maximum value for
    #     a column in the destination table
    #
    #     Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] unique
    #   @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
    #     Insert records where the value of a column is not already present in
    #     the destination table
    #
    #     Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ActionLoadConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Simple load definition
    class ActionSimpleLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Load definition for incremental load modes
    # @!attribute [rw] column
    #   @return [::String]
    #     Column name for incremental load modes
    class ActionIncrementalLoadMode
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents the current state of a workflow invocation action.
  module State
    # The action has not yet been considered for invocation.
    PENDING = 0

    # The action is currently running.
    RUNNING = 1

    # Execution of the action was skipped because upstream dependencies did not
    # all complete successfully. A terminal state.
    SKIPPED = 2

    # Execution of the action was disabled as per the configuration of the
    # corresponding compilation result action. A terminal state.
    DISABLED = 3

    # The action succeeded. A terminal state.
    SUCCEEDED = 4

    # The action was cancelled. A terminal state.
    CANCELLED = 5

    # The action failed. A terminal state.
    FAILED = 6
  end
end