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

Defined Under Namespace

Classes: Access

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Dataset

Returns a new instance of Dataset.



1618
1619
1620
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1618

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:



1500
1501
1502
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1500

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) 


1506
1507
1508
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1506

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:



1511
1512
1513
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1511

def dataset_reference
  @dataset_reference
end

#default_collation ⇒ String

[Output-only] The default collation of the dataset. Corresponds to the JSON property defaultCollation

Returns:

  • (String) 


1516
1517
1518
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1516

def default_collation
  @default_collation
end

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

Corresponds to the JSON property defaultEncryptionConfiguration

Returns:



1521
1522
1523
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1521

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) 


1537
1538
1539
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1537

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) 


1551
1552
1553
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1551

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) 


1556
1557
1558
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1556

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


1561
1562
1563
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1561

def etag
  @etag
end

#friendly_name ⇒ String

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

Returns:

  • (String) 


1566
1567
1568
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1566

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) 


1574
1575
1576
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1574

def id
  @id
end

#is_case_insensitive ⇒ Boolean Also known as: is_case_insensitive?

[Optional] Indicates if table names are case insensitive in the dataset. Corresponds to the JSON property isCaseInsensitive

Returns:

  • (Boolean) 


1579
1580
1581
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1579

def is_case_insensitive
  @is_case_insensitive
end

#kind ⇒ String

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

Returns:

  • (String) 


1585
1586
1587
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1585

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


1592
1593
1594
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1592

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) 


1598
1599
1600
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1598

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) 


1604
1605
1606
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1604

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) 


1609
1610
1611
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1609

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) 


1616
1617
1618
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1616

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1623

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