Class: Google::Cloud::Dataform::V1::CompilationResultAction

Inherits:

Object

• Object
• Google::Cloud::Dataform::V1::CompilationResultAction

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataform/v1/dataform.rb

Overview

Represents a single Dataform action in a compilation result.

Defined Under Namespace

Classes: Assertion, DataPreparation, Declaration, IncrementalLoadMode, LoadConfig, Notebook, Operations, Relation, SimpleLoadMode

Instance Attribute Summary

• #assertion ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Assertion

  The assertion executed by this action.

• #canonical_target ⇒ ::Google::Cloud::Dataform::V1::Target

  The action's identifier if the project had been compiled without any overrides configured.

• #data_preparation ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation

  The data preparation executed by this action.

• #declaration ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Declaration

  The declaration declared by this action.

• #file_path ⇒ ::String

  The full path including filename in which this action is located, relative to the workspace root.

• #internal_metadata ⇒ ::String readonly

  Output only.

• #notebook ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Notebook

  The notebook executed by this action.

• #operations ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Operations

  The database operations executed by this action.

• #relation ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Relation

  The database relation created/updated by this action.

• #target ⇒ ::Google::Cloud::Dataform::V1::Target

  This action's identifier.

Instance Attribute Details

#assertion ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Assertion

Returns The assertion executed by this action.

Note: The following fields are mutually exclusive: assertion, relation, operations, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::Assertion) —

  The assertion executed by this action.

  Note: The following fields are mutually exclusive: assertion, relation, operations, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#canonical_target ⇒ ::Google::Cloud::Dataform::V1::Target

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

Returns:

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

  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/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_preparation ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation

Returns The data preparation executed by this action.

Note: The following fields are mutually exclusive: data_preparation, relation, operations, assertion, declaration, notebook. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation) —

  The data preparation executed by this action.

  Note: The following fields are mutually exclusive: data_preparation, relation, operations, assertion, declaration, notebook. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#declaration ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Declaration

Returns The declaration declared by this action.

Note: The following fields are mutually exclusive: declaration, relation, operations, assertion, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::Declaration) —

  The declaration declared by this action.

  Note: The following fields are mutually exclusive: declaration, relation, operations, assertion, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#file_path ⇒ ::String

Returns The full path including filename in which this action is located, relative to the workspace root.

Returns:

• (::String) —

  The full path including filename in which this action is located, relative to the workspace root.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#notebook ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Notebook

Returns The notebook executed by this action.

Note: The following fields are mutually exclusive: notebook, relation, operations, assertion, declaration, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::Notebook) —

  The notebook executed by this action.

  Note: The following fields are mutually exclusive: notebook, relation, operations, assertion, declaration, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operations ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Operations

Returns The database operations executed by this action.

Note: The following fields are mutually exclusive: operations, relation, assertion, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::Operations) —

  The database operations executed by this action.

  Note: The following fields are mutually exclusive: operations, relation, assertion, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#relation ⇒ ::Google::Cloud::Dataform::V1::CompilationResultAction::Relation

Returns The database relation created/updated by this action.

Note: The following fields are mutually exclusive: relation, operations, assertion, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Dataform::V1::CompilationResultAction::Relation) —

  The database relation created/updated by this action.

  Note: The following fields are mutually exclusive: relation, operations, assertion, declaration, notebook, data_preparation. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#target ⇒ ::Google::Cloud::Dataform::V1::Target

Returns This action's identifier. Unique within the compilation result.

Returns:

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

  This action's identifier. Unique within the compilation result.

# File 'proto_docs/google/cloud/dataform/v1/dataform.rb', line 1678

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
  #     The type of this relation.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which returns rows which this relation should contain.
  # @!attribute [rw] pre_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed before creating the relation.
  # @!attribute [rw] post_operations
  #   @return [::Array<::String>]
  #     SQL statements to be executed after creating the relation.
  # @!attribute [rw] incremental_table_config
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
  #     Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
  #     `relation_type` is `INCREMENTAL_TABLE`.
  # @!attribute [rw] partition_expression
  #   @return [::String]
  #     The SQL expression used to partition the relation.
  # @!attribute [rw] cluster_expressions
  #   @return [::Array<::String>]
  #     A list of columns or SQL expressions used to cluster the table.
  # @!attribute [rw] partition_expiration_days
  #   @return [::Integer]
  #     Sets the partition expiration in days.
  # @!attribute [rw] require_partition_filter
  #   @return [::Boolean]
  #     Specifies whether queries on this table must include a predicate filter
  #     that filters on the partitioning column.
  # @!attribute [rw] additional_options
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Additional options that will be provided as key/value pairs into the
  #     options clause of a create table/view statement. See
  #     https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
  #     for more information on which options are supported.
  # @!attribute [rw] connection
  #   @return [::String]
  #     Optional. The connection specifying the credentials to be used to read
  #     and write to external storage, such as Cloud Storage. The connection can
  #     have the form `{project}.{location}.{connection_id}` or
  #     `projects/{project}/locations/{location}/connections/{connection_id}`,
  #     or be set to DEFAULT.
  # @!attribute [rw] table_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
  #     Optional. The table format for the BigQuery table.
  # @!attribute [rw] file_format
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
  #     Optional. The file format for the BigQuery table.
  # @!attribute [rw] storage_uri
  #   @return [::String]
  #     Optional. The fully qualified location prefix of the external folder
  #     where table data is stored. The URI should be in the format
  #     `gs://bucket/path_to_table/`.
  class Relation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contains settings for relations of type `INCREMENTAL_TABLE`.
    # @!attribute [rw] incremental_select_query
    #   @return [::String]
    #     The SELECT query which returns rows which should be inserted into the
    #     relation if it already exists and is not being refreshed.
    # @!attribute [rw] refresh_disabled
    #   @return [::Boolean]
    #     Whether this table should be protected from being refreshed.
    # @!attribute [rw] unique_key_parts
    #   @return [::Array<::String>]
    #     A set of columns or SQL expressions used to define row uniqueness.
    #     If any duplicates are discovered (as defined by `unique_key_parts`),
    #     only the newly selected rows (as defined by `incremental_select_query`)
    #     will be included in the relation.
    # @!attribute [rw] update_partition_filter
    #   @return [::String]
    #     A SQL expression conditional used to limit the set of existing rows
    #     considered for a merge operation (see `unique_key_parts` for more
    #     information).
    # @!attribute [rw] incremental_pre_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed before inserting new rows into the
    #     relation.
    # @!attribute [rw] incremental_post_operations
    #   @return [::Array<::String>]
    #     SQL statements to be executed after inserting new rows into the
    #     relation.
    class IncrementalTableConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AdditionalOptionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Indicates the type of this relation.
    module RelationType
      # Default value. This value is unused.
      RELATION_TYPE_UNSPECIFIED = 0

      # The relation is a table.
      TABLE = 1

      # The relation is a view.
      VIEW = 2

      # The relation is an incrementalized table.
      INCREMENTAL_TABLE = 3

      # The relation is a materialized view.
      MATERIALIZED_VIEW = 4
    end

    # Supported table formats for BigQuery tables.
    module TableFormat
      # Default value.
      TABLE_FORMAT_UNSPECIFIED = 0

      # Apache Iceberg format.
      ICEBERG = 1
    end

    # Supported file formats for BigQuery tables.
    module FileFormat
      # Default value.
      FILE_FORMAT_UNSPECIFIED = 0

      # Apache Parquet format.
      PARQUET = 1
    end
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for any output relation and its columns. Only set if
  #     `has_output` is true.
  # @!attribute [rw] queries
  #   @return [::Array<::String>]
  #     A list of arbitrary SQL statements that will be executed without
  #     alteration.
  # @!attribute [rw] has_output
  #   @return [::Boolean]
  #     Whether these operations produce an output relation.
  class Operations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an assertion upon a SQL query which is required return zero
  # rows.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1::Target]
  #     The parent action of this assertion. Only set if this assertion was
  #     automatically generated.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     The SELECT query which must return zero rows in order for this assertion
  #     to succeed.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the assertion's automatically-generated view and its
  #     columns.
  class Assertion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a relation which is not managed by Dataform but which may be
  # referenced by Dataform actions.
  # @!attribute [rw] relation_descriptor
  #   @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
  #     Descriptor for the relation and its columns. Used as documentation only,
  #     i.e. values here will result in no changes to the relation's metadata.
  class Declaration
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a notebook.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] contents
  #   @return [::String]
  #     The contents of the notebook.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class Notebook
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a compiled Data Preparation entity
  # @!attribute [rw] contents_yaml
  #   @return [::String]
  #     The data preparation definition, stored as a YAML string.
  #
  #     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::V1::CompilationResultAction::DataPreparation::SqlDefinition]
  #     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 [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     Whether this action is disabled (i.e. should not be run).
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Arbitrary, user-defined tags on this action.
  class DataPreparation
    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::V1::CompilationResultAction::DataPreparation::ErrorTable]
    #     Error table configuration,
    # @!attribute [rw] load
    #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
    #     Load configuration.
    class SqlDefinition
      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::V1::Target]
    #     Error Table target.
    # @!attribute [rw] retention_days
    #   @return [::Integer]
    #     Error table partition expiration in days. Only positive values are
    #     allowed.
    class ErrorTable
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Simplified load configuration for actions
  # @!attribute [rw] replace
  #   @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::SimpleLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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::V1::CompilationResultAction::IncrementalLoadMode]
  #     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 LoadConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Simple load definition
  class SimpleLoadMode
    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 IncrementalLoadMode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end