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, Tag

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Dataset

Returns a new instance of Dataset.



1768
1769
1770
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1768

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:



1622
1623
1624
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1622

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) 


1628
1629
1630
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1628

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:



1633
1634
1635
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1633

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) 


1638
1639
1640
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1638

def default_collation
  @default_collation
end

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

Corresponds to the JSON property defaultEncryptionConfiguration

Returns:



1643
1644
1645
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1643

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) 


1659
1660
1661
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1659

def default_partition_expiration_ms
  @default_partition_expiration_ms
end

#default_rounding_mode ⇒ String

[Output-only] The default rounding mode of the dataset. Corresponds to the JSON property defaultRoundingMode

Returns:

  • (String) 


1664
1665
1666
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1664

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


1678
1679
1680
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1678

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) 


1683
1684
1685
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1683

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


1688
1689
1690
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1688

def etag
  @etag
end

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

[Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL. Corresponds to the JSON property externalDatasetReference

Returns:



1694
1695
1696
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1694

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) 


1699
1700
1701
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1699

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) 


1707
1708
1709
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1707

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) 


1712
1713
1714
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1712

def is_case_insensitive
  @is_case_insensitive
end

#kind ⇒ String

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

Returns:

  • (String) 


1718
1719
1720
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1718

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


1725
1726
1727
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1725

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) 


1731
1732
1733
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1731

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) 


1737
1738
1739
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1737

def location
  @location
end

#max_time_travel_hours ⇒ Fixnum

[Optional] Number of hours for the max time travel for all tables in the dataset. Corresponds to the JSON property maxTimeTravelHours

Returns:

  • (Fixnum) 


1743
1744
1745
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1743

def max_time_travel_hours
  @max_time_travel_hours
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


1748
1749
1750
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1748

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) 


1755
1756
1757
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1755

def self_link
  @self_link
end

#storage_billing_model ⇒ String

[Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL. Corresponds to the JSON property storageBillingModel

Returns:

  • (String) 


1761
1762
1763
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1761

def storage_billing_model
  @storage_billing_model
end

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

[Optional]The tags associated with this dataset. Tag keys are globally unique. Corresponds to the JSON property tags

Returns:



1766
1767
1768
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1766

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1773

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