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_encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration
Corresponds to the JSON property
defaultEncryptionConfiguration
. -
#default_partition_expiration_ms ⇒ Fixnum
[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds.
-
#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.
1182 1183 1184 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1182 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
1081 1082 1083 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1081 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
1087 1088 1089 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1087 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
1092 1093 1094 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1092 def dataset_reference @dataset_reference end |
#default_encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration
Corresponds to the JSON property defaultEncryptionConfiguration
1097 1098 1099 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1097 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
1113 1114 1115 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1113 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
1127 1128 1129 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1127 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
1132 1133 1134 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1132 def description @description end |
#etag ⇒ String
[Output-only] A hash of the resource.
Corresponds to the JSON property etag
1137 1138 1139 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1137 def etag @etag end |
#friendly_name ⇒ String
[Optional] A descriptive name for the dataset.
Corresponds to the JSON property friendlyName
1142 1143 1144 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1142 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
1150 1151 1152 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1150 def id @id end |
#kind ⇒ String
[Output-only] The resource type.
Corresponds to the JSON property kind
1155 1156 1157 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1155 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
1162 1163 1164 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1162 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
1168 1169 1170 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1168 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
1174 1175 1176 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1174 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
1180 1181 1182 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1180 def self_link @self_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1187 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) @self_link = args[:self_link] if args.key?(:self_link) end |