Class: Google::Cloud::Dataform::V1beta1::CompilationResultAction

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

Overview

Represents a single Dataform action in a compilation result.

Defined Under Namespace

Classes: Assertion, Declaration, Notebook, Operations, Relation

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The assertion executed by this action.

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

Returns The declaration declared by this action.

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
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.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
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.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

Returns The notebook executed by this action.

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

Returns The database operations executed by this action.

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

Returns The database relation created/updated by this action.

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end

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

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

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'proto_docs/google/cloud/dataform/v1beta1/dataform.rb', line 1594

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

  # Represents a database relation.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::RelationDescriptor]
  #     Descriptor for the relation and its columns.
  # @!attribute [rw] relation_type
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
  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
  end

  # Represents a list of arbitrary database operations.
  # @!attribute [rw] dependency_targets
  #   @return [::Array<::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::Target>]
  #     A list of actions that this action depends on.
  # @!attribute [rw] parent_action
  #   @return [::Google::Cloud::Dataform::V1beta1::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::V1beta1::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::V1beta1::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::V1beta1::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
end