Class: Google::Cloud::Datastream::V1::BigQueryDestinationConfig

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

Overview

BigQuery destination configuration

Defined Under Namespace

Classes: AppendOnly, Merge, SingleTargetDataset, SourceHierarchyDatasets

Instance Attribute Summary collapse

Instance Attribute Details

#append_only ⇒ ::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::AppendOnly

Returns Append only mode.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 997

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

  # A single target dataset to which all data will be streamed.
  # @!attribute [rw] dataset_id
  #   @return [::String]
  #     The dataset ID of the target dataset.
  #     DatasetIds allowed characters:
  #     https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
  class SingleTargetDataset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destination datasets are created so that hierarchy of the destination data
  # objects matches the source hierarchy.
  # @!attribute [rw] dataset_template
  #   @return [::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets::DatasetTemplate]
  #     The dataset template to use for dynamic dataset creation.
  class SourceHierarchyDatasets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Dataset template used for dynamic dataset creation.
    # @!attribute [rw] location
    #   @return [::String]
    #     Required. The geographic location where the dataset should reside. See
    #     https://cloud.google.com/bigquery/docs/locations for supported
    #     locations.
    # @!attribute [rw] dataset_id_prefix
    #   @return [::String]
    #     If supplied, every created dataset will have its name prefixed by the
    #     provided value. The prefix and name will be separated by an underscore.
    #     i.e. <prefix>_<dataset_name>.
    # @!attribute [rw] kms_key_name
    #   @return [::String]
    #     Describes the Cloud KMS encryption key that will be used to
    #     protect destination BigQuery table. The BigQuery Service Account
    #     associated with your project requires access to this encryption key.
    #     i.e.
    #     projects/\\{project}/locations/\\{location}/keyRings/\\{key_ring}/cryptoKeys/\\{cryptoKey}.
    #     See https://cloud.google.com/bigquery/docs/customer-managed-encryption
    #     for more information.
    class DatasetTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # AppendOnly mode defines that all changes to a table will be written to the
  # destination table.
  class AppendOnly
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Merge mode defines that all changes to a table will be merged at the
  # destination table.
  class Merge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_freshness ⇒ ::Google::Protobuf::Duration

Returns The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.

Returns:

  • (::Google::Protobuf::Duration) —

    The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 997

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

  # A single target dataset to which all data will be streamed.
  # @!attribute [rw] dataset_id
  #   @return [::String]
  #     The dataset ID of the target dataset.
  #     DatasetIds allowed characters:
  #     https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
  class SingleTargetDataset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destination datasets are created so that hierarchy of the destination data
  # objects matches the source hierarchy.
  # @!attribute [rw] dataset_template
  #   @return [::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets::DatasetTemplate]
  #     The dataset template to use for dynamic dataset creation.
  class SourceHierarchyDatasets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Dataset template used for dynamic dataset creation.
    # @!attribute [rw] location
    #   @return [::String]
    #     Required. The geographic location where the dataset should reside. See
    #     https://cloud.google.com/bigquery/docs/locations for supported
    #     locations.
    # @!attribute [rw] dataset_id_prefix
    #   @return [::String]
    #     If supplied, every created dataset will have its name prefixed by the
    #     provided value. The prefix and name will be separated by an underscore.
    #     i.e. <prefix>_<dataset_name>.
    # @!attribute [rw] kms_key_name
    #   @return [::String]
    #     Describes the Cloud KMS encryption key that will be used to
    #     protect destination BigQuery table. The BigQuery Service Account
    #     associated with your project requires access to this encryption key.
    #     i.e.
    #     projects/\\{project}/locations/\\{location}/keyRings/\\{key_ring}/cryptoKeys/\\{cryptoKey}.
    #     See https://cloud.google.com/bigquery/docs/customer-managed-encryption
    #     for more information.
    class DatasetTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # AppendOnly mode defines that all changes to a table will be written to the
  # destination table.
  class AppendOnly
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Merge mode defines that all changes to a table will be merged at the
  # destination table.
  class Merge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merge ⇒ ::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::Merge

Returns The standard mode.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 997

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

  # A single target dataset to which all data will be streamed.
  # @!attribute [rw] dataset_id
  #   @return [::String]
  #     The dataset ID of the target dataset.
  #     DatasetIds allowed characters:
  #     https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
  class SingleTargetDataset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destination datasets are created so that hierarchy of the destination data
  # objects matches the source hierarchy.
  # @!attribute [rw] dataset_template
  #   @return [::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets::DatasetTemplate]
  #     The dataset template to use for dynamic dataset creation.
  class SourceHierarchyDatasets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Dataset template used for dynamic dataset creation.
    # @!attribute [rw] location
    #   @return [::String]
    #     Required. The geographic location where the dataset should reside. See
    #     https://cloud.google.com/bigquery/docs/locations for supported
    #     locations.
    # @!attribute [rw] dataset_id_prefix
    #   @return [::String]
    #     If supplied, every created dataset will have its name prefixed by the
    #     provided value. The prefix and name will be separated by an underscore.
    #     i.e. <prefix>_<dataset_name>.
    # @!attribute [rw] kms_key_name
    #   @return [::String]
    #     Describes the Cloud KMS encryption key that will be used to
    #     protect destination BigQuery table. The BigQuery Service Account
    #     associated with your project requires access to this encryption key.
    #     i.e.
    #     projects/\\{project}/locations/\\{location}/keyRings/\\{key_ring}/cryptoKeys/\\{cryptoKey}.
    #     See https://cloud.google.com/bigquery/docs/customer-managed-encryption
    #     for more information.
    class DatasetTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # AppendOnly mode defines that all changes to a table will be written to the
  # destination table.
  class AppendOnly
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Merge mode defines that all changes to a table will be merged at the
  # destination table.
  class Merge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#single_target_dataset ⇒ ::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SingleTargetDataset

Returns Single destination dataset.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 997

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

  # A single target dataset to which all data will be streamed.
  # @!attribute [rw] dataset_id
  #   @return [::String]
  #     The dataset ID of the target dataset.
  #     DatasetIds allowed characters:
  #     https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
  class SingleTargetDataset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destination datasets are created so that hierarchy of the destination data
  # objects matches the source hierarchy.
  # @!attribute [rw] dataset_template
  #   @return [::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets::DatasetTemplate]
  #     The dataset template to use for dynamic dataset creation.
  class SourceHierarchyDatasets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Dataset template used for dynamic dataset creation.
    # @!attribute [rw] location
    #   @return [::String]
    #     Required. The geographic location where the dataset should reside. See
    #     https://cloud.google.com/bigquery/docs/locations for supported
    #     locations.
    # @!attribute [rw] dataset_id_prefix
    #   @return [::String]
    #     If supplied, every created dataset will have its name prefixed by the
    #     provided value. The prefix and name will be separated by an underscore.
    #     i.e. <prefix>_<dataset_name>.
    # @!attribute [rw] kms_key_name
    #   @return [::String]
    #     Describes the Cloud KMS encryption key that will be used to
    #     protect destination BigQuery table. The BigQuery Service Account
    #     associated with your project requires access to this encryption key.
    #     i.e.
    #     projects/\\{project}/locations/\\{location}/keyRings/\\{key_ring}/cryptoKeys/\\{cryptoKey}.
    #     See https://cloud.google.com/bigquery/docs/customer-managed-encryption
    #     for more information.
    class DatasetTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # AppendOnly mode defines that all changes to a table will be written to the
  # destination table.
  class AppendOnly
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Merge mode defines that all changes to a table will be merged at the
  # destination table.
  class Merge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source_hierarchy_datasets ⇒ ::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets

Returns Source hierarchy datasets.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 997

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

  # A single target dataset to which all data will be streamed.
  # @!attribute [rw] dataset_id
  #   @return [::String]
  #     The dataset ID of the target dataset.
  #     DatasetIds allowed characters:
  #     https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.
  class SingleTargetDataset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destination datasets are created so that hierarchy of the destination data
  # objects matches the source hierarchy.
  # @!attribute [rw] dataset_template
  #   @return [::Google::Cloud::Datastream::V1::BigQueryDestinationConfig::SourceHierarchyDatasets::DatasetTemplate]
  #     The dataset template to use for dynamic dataset creation.
  class SourceHierarchyDatasets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Dataset template used for dynamic dataset creation.
    # @!attribute [rw] location
    #   @return [::String]
    #     Required. The geographic location where the dataset should reside. See
    #     https://cloud.google.com/bigquery/docs/locations for supported
    #     locations.
    # @!attribute [rw] dataset_id_prefix
    #   @return [::String]
    #     If supplied, every created dataset will have its name prefixed by the
    #     provided value. The prefix and name will be separated by an underscore.
    #     i.e. <prefix>_<dataset_name>.
    # @!attribute [rw] kms_key_name
    #   @return [::String]
    #     Describes the Cloud KMS encryption key that will be used to
    #     protect destination BigQuery table. The BigQuery Service Account
    #     associated with your project requires access to this encryption key.
    #     i.e.
    #     projects/\\{project}/locations/\\{location}/keyRings/\\{key_ring}/cryptoKeys/\\{cryptoKey}.
    #     See https://cloud.google.com/bigquery/docs/customer-managed-encryption
    #     for more information.
    class DatasetTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # AppendOnly mode defines that all changes to a table will be written to the
  # destination table.
  class AppendOnly
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Merge mode defines that all changes to a table will be merged at the
  # destination table.
  class Merge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end