Class: Google::Apis::BigqueryV2::Dataset

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Overview

Represents a BigQuery dataset.

Defined Under Namespace

Classes: Access, Tag

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Dataset

Returns a new instance of Dataset.



2163
2164
2165
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2163

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access ⇒ Array<Google::Apis::BigqueryV2::Dataset::Access>

Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. Corresponds to the JSON property access

Returns:



1944
1945
1946
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1944

def access
  @access
end

#catalog_source ⇒ String

Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake Corresponds to the JSON property catalogSource

Returns:

  • (String) 


1951
1952
1953
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1951

def catalog_source
  @catalog_source
end

#creation_time ⇒ Fixnum

Output only. The time when this dataset was created, in milliseconds since the epoch. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


1957
1958
1959
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1957

def creation_time
  @creation_time
end

#dataset_reference ⇒ Google::Apis::BigqueryV2::DatasetReference

Identifier for a dataset. Corresponds to the JSON property datasetReference

Returns:



1962
1963
1964
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1962

def dataset_reference
  @dataset_reference
end

#default_collation ⇒ String

Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und: ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. Corresponds to the JSON property defaultCollation

Returns:

  • (String) 


1974
1975
1976
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1974

def default_collation
  @default_collation
end

#default_encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration

Configuration for Cloud KMS encryption settings. Corresponds to the JSON property defaultEncryptionConfiguration

Returns:



1979
1980
1981
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1979

def default_encryption_configuration
  @default_encryption_configuration
end

#default_partition_expiration_ms ⇒ Fixnum

This default partition expiration, expressed in milliseconds. When new time- partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning. expirationMs property on the new table. If you set TimePartitioning. expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline. Corresponds to the JSON property defaultPartitionExpirationMs

Returns:

  • (Fixnum) 


1992
1993
1994
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1992

def default_partition_expiration_ms
  @default_partition_expiration_ms
end

#default_rounding_mode ⇒ String

Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified. Corresponds to the JSON property defaultRoundingMode

Returns:

  • (String) 


2003
2004
2005
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2003

def default_rounding_mode
  @default_rounding_mode
end

#default_table_expiration_ms ⇒ Fixnum

Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property. Corresponds to the JSON property defaultTableExpirationMs

Returns:

  • (Fixnum) 


2018
2019
2020
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2018

def default_table_expiration_ms
  @default_table_expiration_ms
end

#description ⇒ String

Optional. A user-friendly description of the dataset. Corresponds to the JSON property description

Returns:

  • (String) 


2023
2024
2025
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2023

def description
  @description
end

#etag ⇒ String

Output only. A hash of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2028
2029
2030
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2028

def etag
  @etag
end

#external_catalog_dataset_options ⇒ Google::Apis::BigqueryV2::ExternalCatalogDatasetOptions

Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema, or namespace represented by the current dataset. Corresponds to the JSON property externalCatalogDatasetOptions

Returns:



2035
2036
2037
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2035

def external_catalog_dataset_options
  @external_catalog_dataset_options
end

#external_dataset_reference ⇒ Google::Apis::BigqueryV2::ExternalDatasetReference

Configures the access a dataset defined in an external metadata storage. Corresponds to the JSON property externalDatasetReference

Returns:



2040
2041
2042
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2040

def external_dataset_reference
  @external_dataset_reference
end

#friendly_name ⇒ String

Optional. A descriptive name for the dataset. Corresponds to the JSON property friendlyName

Returns:

  • (String) 


2045
2046
2047
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2045

def friendly_name
  @friendly_name
end

#id ⇒ String

Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. Corresponds to the JSON property id

Returns:

  • (String) 


2053
2054
2055
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2053

def id
  @id
end

#is_case_insensitive ⇒ Boolean Also known as: is_case_insensitive?

Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. Corresponds to the JSON property isCaseInsensitive

Returns:

  • (Boolean) 


2060
2061
2062
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2060

def is_case_insensitive
  @is_case_insensitive
end

#kind ⇒ String

Output only. The resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


2066
2067
2068
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2066

def kind
  @kind
end

#labels ⇒ Hash<String,String>

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2075
2076
2077
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2075

def labels
  @labels
end

#last_modified_time ⇒ Fixnum

Output only. The date when this dataset was last modified, in milliseconds since the epoch. Corresponds to the JSON property lastModifiedTime

Returns:

  • (Fixnum) 


2081
2082
2083
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2081

def last_modified_time
  @last_modified_time
end

#linked_dataset_metadata ⇒ Google::Apis::BigqueryV2::LinkedDatasetMetadata

Metadata about the Linked Dataset. Corresponds to the JSON property linkedDatasetMetadata

Returns:



2086
2087
2088
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2086

def linked_dataset_metadata
  @linked_dataset_metadata
end

#linked_dataset_source ⇒ Google::Apis::BigqueryV2::LinkedDatasetSource

A dataset source type which refers to another BigQuery dataset. Corresponds to the JSON property linkedDatasetSource

Returns:



2091
2092
2093
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2091

def linked_dataset_source
  @linked_dataset_source
end

#location ⇒ String

The geographic location where the dataset should reside. See https://cloud. google.com/bigquery/docs/locations for supported locations. Corresponds to the JSON property location

Returns:

  • (String) 


2097
2098
2099
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2097

def location
  @location
end

#max_time_travel_hours ⇒ Fixnum

Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. Corresponds to the JSON property maxTimeTravelHours

Returns:

  • (Fixnum) 


2103
2104
2105
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2103

def max_time_travel_hours
  @max_time_travel_hours
end

#resource_tags ⇒ Hash<String,String>

Optional. The tags attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See Tag definitions for more details. Corresponds to the JSON property resourceTags

Returns:

  • (Hash<String,String>) 


2114
2115
2116
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2114

def resource_tags
  @resource_tags
end

#restrictions ⇒ Google::Apis::BigqueryV2::RestrictionConfig

Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See Data egress for more details. Corresponds to the JSON property restrictions

Returns:



2122
2123
2124
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2122

def restrictions
  @restrictions
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


2127
2128
2129
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2127

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2133
2134
2135
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2133

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2140
2141
2142
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2140

def self_link
  @self_link
end

#storage_billing_model ⇒ String

Optional. Updates storage_billing_model for the dataset. Corresponds to the JSON property storageBillingModel

Returns:

  • (String) 


2145
2146
2147
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2145

def storage_billing_model
  @storage_billing_model
end

#tags ⇒ Array<Google::Apis::BigqueryV2::Dataset::Tag>

Output only. Tags for the dataset. To provide tags as inputs, use the resourceTags field. Corresponds to the JSON property tags

Returns:



2151
2152
2153
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2151

def tags
  @tags
end

#type ⇒ String

Output only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC

  • accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. Corresponds to the JSON property type

Returns:

  • (String) 


2161
2162
2163
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2161

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2168

def update!(**args)
  @access = args[:access] if args.key?(:access)
  @catalog_source = args[:catalog_source] if args.key?(:catalog_source)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @dataset_reference = args[:dataset_reference] if args.key?(:dataset_reference)
  @default_collation = args[:default_collation] if args.key?(:default_collation)
  @default_encryption_configuration = args[:default_encryption_configuration] if args.key?(:default_encryption_configuration)
  @default_partition_expiration_ms = args[:default_partition_expiration_ms] if args.key?(:default_partition_expiration_ms)
  @default_rounding_mode = args[:default_rounding_mode] if args.key?(:default_rounding_mode)
  @default_table_expiration_ms = args[:default_table_expiration_ms] if args.key?(:default_table_expiration_ms)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @external_catalog_dataset_options = args[:external_catalog_dataset_options] if args.key?(:external_catalog_dataset_options)
  @external_dataset_reference = args[:external_dataset_reference] if args.key?(:external_dataset_reference)
  @friendly_name = args[:friendly_name] if args.key?(:friendly_name)
  @id = args[:id] if args.key?(:id)
  @is_case_insensitive = args[:is_case_insensitive] if args.key?(:is_case_insensitive)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @linked_dataset_metadata = args[:linked_dataset_metadata] if args.key?(:linked_dataset_metadata)
  @linked_dataset_source = args[:linked_dataset_source] if args.key?(:linked_dataset_source)
  @location = args[:location] if args.key?(:location)
  @max_time_travel_hours = args[:max_time_travel_hours] if args.key?(:max_time_travel_hours)
  @resource_tags = args[:resource_tags] if args.key?(:resource_tags)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @storage_billing_model = args[:storage_billing_model] if args.key?(:storage_billing_model)
  @tags = args[:tags] if args.key?(:tags)
  @type = args[:type] if args.key?(:type)
end