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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Dataset

Returns a new instance of Dataset.



1464
1465
1466
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1464

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

Returns:



1357
1358
1359
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1357

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

Returns:

  • (Fixnum) 


1363
1364
1365
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1363

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

Returns:



1368
1369
1370
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1368

def dataset_reference
  @dataset_reference
end

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

Corresponds to the JSON property defaultEncryptionConfiguration

Returns:



1373
1374
1375
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1373

def default_encryption_configuration
  @default_encryption_configuration
end

#default_partition_expiration_ms ⇒ Fixnum

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning. expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. Corresponds to the JSON property defaultPartitionExpirationMs

Returns:

  • (Fixnum) 


1389
1390
1391
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1389

def default_partition_expiration_ms
  @default_partition_expiration_ms
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

Returns:

  • (Fixnum) 


1403
1404
1405
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1403

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) 


1408
1409
1410
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1408

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


1413
1414
1415
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1413

def etag
  @etag
end

#friendly_name ⇒ String

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

Returns:

  • (String) 


1418
1419
1420
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1418

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) 


1426
1427
1428
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1426

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1431
1432
1433
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1431

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>) 


1438
1439
1440
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1438

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

Returns:

  • (Fixnum) 


1444
1445
1446
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1444

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/locations. Corresponds to the JSON property location

Returns:

  • (String) 


1450
1451
1452
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1450

def location
  @location
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output-only] Reserved for future use. Corresponds to the JSON property satisfiesPZS

Returns:

  • (Boolean) 


1455
1456
1457
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1455

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) 


1462
1463
1464
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1462

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1469

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_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_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)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
end