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 ⇒ Fixnum
[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 ⇒ Fixnum
[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>
The labels associated with this dataset.
-
#last_modified_time ⇒ Fixnum
[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
-
#location ⇒ String
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
384 385 386 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 384 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
304 305 306 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 304 def access @access end |
#creation_time ⇒ Fixnum
[Output-only] The time when this dataset was created, in milliseconds since
the epoch.
Corresponds to the JSON property creationTime
310 311 312 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 310 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
315 316 317 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 315 def dataset_reference @dataset_reference end |
#default_table_expiration_ms ⇒ Fixnum
[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
329 330 331 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 329 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
334 335 336 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 334 def description @description end |
#etag ⇒ String
[Output-only] A hash of the resource.
Corresponds to the JSON property etag
339 340 341 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 339 def etag @etag end |
#friendly_name ⇒ String
[Optional] A descriptive name for the dataset.
Corresponds to the JSON property friendlyName
344 345 346 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 344 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
352 353 354 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 352 def id @id end |
#kind ⇒ String
[Output-only] The resource type.
Corresponds to the JSON property kind
357 358 359 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 357 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 Labeling Datasets for more information.
Corresponds to the JSON property labels
364 365 366 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 364 def labels @labels end |
#last_modified_time ⇒ Fixnum
[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
370 371 372 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 370 def last_modified_time @last_modified_time end |
#location ⇒ String
The geographic location where the dataset should reside. The default value is
US. See details at https://cloud.google.com/bigquery/docs/dataset-locations.
Corresponds to the JSON property location
376 377 378 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 376 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
382 383 384 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 382 def self_link @self_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 389 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 |