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

Inherits:

Object

• Object
• Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction

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, NotebookAction

Instance Attribute Summary

• #bigquery_action ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction readonly

  Output only.

• #canonical_target ⇒ ::Google::Cloud::Dataform::V1beta1::Target readonly

  Output only.

• #failure_reason ⇒ ::String readonly

  Output only.

• #internal_metadata ⇒ ::String readonly

  Output only.

• #invocation_timing ⇒ ::Google::Type::Interval readonly

  Output only.

• #notebook_action ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::NotebookAction readonly

  Output only.

• #state ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::State readonly

  Output only.

• #target ⇒ ::Google::Cloud::Dataform::V1beta1::Target readonly

  Output only.

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. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction) —

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

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

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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:

• (::Google::Cloud::Dataform::V1beta1::Target) —

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

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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.

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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.

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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.

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::NotebookAction) —

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

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

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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:

• (::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::State) —

  Output only. This action's current state.

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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:

• (::Google::Cloud::Dataform::V1beta1::Target) —

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

# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 2212

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 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