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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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.



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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.



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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.



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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:



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2676

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 Gemini Enterprise Agent Platform 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.
  # @!attribute [r] file_path
  #   @return [::String]
  #     Output only. The path to the notebook file in the repository.
  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