Class: Google::Apis::BigqueryV2::Dataset
- Inherits:
-
Object
- Object
- Google::Apis::BigqueryV2::Dataset
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb
Defined Under Namespace
Classes: Access
Instance Attribute Summary collapse
-
#access ⇒ Array<Google::Apis::BigqueryV2::Dataset::Access>
[Optional] An array of objects that define dataset access for one or more entities.
-
#creation_time ⇒ String
[Output-only] The time when this dataset was created, in milliseconds since the epoch.
-
#dataset_reference ⇒ Google::Apis::BigqueryV2::DatasetReference
[Required] A reference that identifies the dataset.
-
#default_table_expiration_ms ⇒ String
[Optional] The default lifetime of all tables in the dataset, in milliseconds.
-
#description ⇒ String
[Optional] A user-friendly description of the dataset.
-
#etag ⇒ String
[Output-only] A hash of the resource.
-
#friendly_name ⇒ String
[Optional] A descriptive name for the dataset.
-
#id ⇒ String
[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId.
-
#kind ⇒ String
[Output-only] The resource type.
-
#labels ⇒ Hash<String,String>
[Experimental] The labels associated with this dataset.
-
#last_modified_time ⇒ String
[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
-
#location ⇒ String
[Experimental] The geographic location where the dataset should reside.
-
#self_link ⇒ String
[Output-only] A URL that can be used to access the resource again.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Dataset
constructor
A new instance of Dataset.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Dataset
Returns a new instance of Dataset.
362 363 364 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 362 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;
Corresponds to the JSON property access
282 283 284 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 282 def access @access end |
#creation_time ⇒ String
[Output-only] The time when this dataset was created, in milliseconds since
the epoch.
Corresponds to the JSON property creationTime
288 289 290 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 288 def creation_time @creation_time end |
#dataset_reference ⇒ Google::Apis::BigqueryV2::DatasetReference
[Required] A reference that identifies the dataset.
Corresponds to the JSON property datasetReference
293 294 295 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 293 def dataset_reference @dataset_reference end |
#default_table_expiration_ms ⇒ String
[Optional] The default lifetime of all tables in the dataset, in milliseconds.
The minimum value is 3600000 milliseconds (one hour). 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
307 308 309 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 307 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
312 313 314 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 312 def description @description end |
#etag ⇒ String
[Output-only] A hash of the resource.
Corresponds to the JSON property etag
317 318 319 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 317 def etag @etag end |
#friendly_name ⇒ String
[Optional] A descriptive name for the dataset.
Corresponds to the JSON property friendlyName
322 323 324 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 322 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
330 331 332 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 330 def id @id end |
#kind ⇒ String
[Output-only] The resource type.
Corresponds to the JSON property kind
335 336 337 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 335 def kind @kind end |
#labels ⇒ Hash<String,String>
[Experimental] 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 Labeling Datasets for more information.
Corresponds to the JSON property labels
342 343 344 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 342 def labels @labels end |
#last_modified_time ⇒ String
[Output-only] The date when this dataset or any of its tables was last
modified, in milliseconds since the epoch.
Corresponds to the JSON property lastModifiedTime
348 349 350 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 348 def last_modified_time @last_modified_time end |
#location ⇒ String
[Experimental] The geographic location where the dataset should reside.
Possible values include EU and US. The default value is US.
Corresponds to the JSON property location
354 355 356 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 354 def location @location 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
360 361 362 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 360 def self_link @self_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 367 def update!(**args) @access = args[:access] if args.key?(:access) @creation_time = args[:creation_time] if args.key?(:creation_time) @dataset_reference = args[:dataset_reference] if args.key?(:dataset_reference) @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) @friendly_name = args[:friendly_name] if args.key?(:friendly_name) @id = args[:id] if args.key?(:id) @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) @location = args[:location] if args.key?(:location) @self_link = args[:self_link] if args.key?(:self_link) end |