Class: Google::Apis::BigqueryV2::Table
- Inherits:
-
Object
- Object
- Google::Apis::BigqueryV2::Table
- 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
Instance Attribute Summary collapse
-
#clustering ⇒ Google::Apis::BigqueryV2::Clustering
[Beta] Clustering specification for the table.
-
#creation_time ⇒ Fixnum
[Output-only] The time when this table was created, in milliseconds since the epoch.
-
#description ⇒ String
[Optional] A user-friendly description of this table.
-
#encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration
Custom encryption configuration (e.g., Cloud KMS keys).
-
#etag ⇒ String
[Output-only] A hash of the table metadata.
-
#expiration_time ⇒ Fixnum
[Optional] The time when this table expires, in milliseconds since the epoch.
-
#external_data_configuration ⇒ Google::Apis::BigqueryV2::ExternalDataConfiguration
[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery.
-
#friendly_name ⇒ String
[Optional] A descriptive name for this table.
-
#id ⇒ String
[Output-only] An opaque ID uniquely identifying the table.
-
#kind ⇒ String
[Output-only] The type of the resource.
-
#labels ⇒ Hash<String,String>
The labels associated with this table.
-
#last_modified_time ⇒ Fixnum
[Output-only] The time when this table was last modified, in milliseconds since the epoch.
-
#location ⇒ String
[Output-only] The geographic location where the table resides.
-
#materialized_view ⇒ Google::Apis::BigqueryV2::MaterializedViewDefinition
[Optional] Materialized view definition.
-
#model ⇒ Google::Apis::BigqueryV2::ModelDefinition
[Output-only, Beta] Present iff this table represents a ML model.
-
#num_bytes ⇒ Fixnum
[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
-
#num_long_term_bytes ⇒ Fixnum
[Output-only] The number of bytes in the table that are considered "long-term storage".
-
#num_physical_bytes ⇒ Fixnum
[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer.
-
#num_rows ⇒ Fixnum
[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
-
#range_partitioning ⇒ Google::Apis::BigqueryV2::RangePartitioning
[TrustedTester] Range partitioning specification for this table.
-
#require_partition_filter ⇒ Boolean
(also: #require_partition_filter?)
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
-
#schema ⇒ Google::Apis::BigqueryV2::TableSchema
[Optional] Describes the schema of this table.
-
#self_link ⇒ String
[Output-only] A URL that can be used to access this resource again.
-
#streaming_buffer ⇒ Google::Apis::BigqueryV2::Streamingbuffer
[Output-only] Contains information regarding this table's streaming buffer, if one is present.
-
#table_reference ⇒ Google::Apis::BigqueryV2::TableReference
[Required] Reference describing the ID of this table.
-
#time_partitioning ⇒ Google::Apis::BigqueryV2::TimePartitioning
Time-based partitioning specification for this table.
-
#type ⇒ String
[Output-only] Describes the table type.
-
#view ⇒ Google::Apis::BigqueryV2::ViewDefinition
[Optional] The view definition.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Table
constructor
A new instance of Table.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Table
Returns a new instance of Table.
5051 5052 5053 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5051 def initialize(**args) update!(**args) end |
Instance Attribute Details
#clustering ⇒ Google::Apis::BigqueryV2::Clustering
[Beta] Clustering specification for the table. Must be specified with
partitioning, data in the table will be first partitioned and subsequently
clustered.
Corresponds to the JSON property clustering
4881 4882 4883 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4881 def clustering @clustering end |
#creation_time ⇒ Fixnum
[Output-only] The time when this table was created, in milliseconds since the
epoch.
Corresponds to the JSON property creationTime
4887 4888 4889 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4887 def creation_time @creation_time end |
#description ⇒ String
[Optional] A user-friendly description of this table.
Corresponds to the JSON property description
4892 4893 4894 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4892 def description @description end |
#encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration
Custom encryption configuration (e.g., Cloud KMS keys).
Corresponds to the JSON property encryptionConfiguration
4897 4898 4899 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4897 def encryption_configuration @encryption_configuration end |
#etag ⇒ String
[Output-only] A hash of the table metadata. Used to ensure there were no
concurrent modifications to the resource when attempting an update. Not
guaranteed to change when the table contents or the fields numRows, numBytes,
numLongTermBytes or lastModifiedTime change.
Corresponds to the JSON property etag
4905 4906 4907 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4905 def etag @etag end |
#expiration_time ⇒ Fixnum
[Optional] The time when this table expires, in milliseconds since the epoch.
If not present, the table will persist indefinitely. Expired tables will be
deleted and their storage reclaimed. The defaultTableExpirationMs property of
the encapsulating dataset can be used to set a default expirationTime on newly
created tables.
Corresponds to the JSON property expirationTime
4914 4915 4916 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4914 def expiration_time @expiration_time end |
#external_data_configuration ⇒ Google::Apis::BigqueryV2::ExternalDataConfiguration
[Optional] Describes the data format, location, and other properties of a
table stored outside of BigQuery. By defining these properties, the data
source can then be queried as if it were a standard BigQuery table.
Corresponds to the JSON property externalDataConfiguration
4921 4922 4923 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4921 def external_data_configuration @external_data_configuration end |
#friendly_name ⇒ String
[Optional] A descriptive name for this table.
Corresponds to the JSON property friendlyName
4926 4927 4928 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4926 def friendly_name @friendly_name end |
#id ⇒ String
[Output-only] An opaque ID uniquely identifying the table.
Corresponds to the JSON property id
4931 4932 4933 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4931 def id @id end |
#kind ⇒ String
[Output-only] The type of the resource.
Corresponds to the JSON property kind
4936 4937 4938 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4936 def kind @kind end |
#labels ⇒ Hash<String,String>
The labels associated with this table. You can use these to organize and group
your tables. Label keys and values can be no longer than 63 characters, can
only contain lowercase letters, numeric characters, underscores and dashes.
International characters are allowed. Label values are optional. Label keys
must start with a letter and each label in the list must have a different key.
Corresponds to the JSON property labels
4945 4946 4947 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4945 def labels @labels end |
#last_modified_time ⇒ Fixnum
[Output-only] The time when this table was last modified, in milliseconds
since the epoch.
Corresponds to the JSON property lastModifiedTime
4951 4952 4953 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4951 def last_modified_time @last_modified_time end |
#location ⇒ String
[Output-only] The geographic location where the table resides. This value is
inherited from the dataset.
Corresponds to the JSON property location
4957 4958 4959 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4957 def location @location end |
#materialized_view ⇒ Google::Apis::BigqueryV2::MaterializedViewDefinition
[Optional] Materialized view definition.
Corresponds to the JSON property materializedView
4962 4963 4964 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4962 def materialized_view @materialized_view end |
#model ⇒ Google::Apis::BigqueryV2::ModelDefinition
[Output-only, Beta] Present iff this table represents a ML model. Describes
the training information for the model, and it is required to run 'PREDICT'
queries.
Corresponds to the JSON property model
4969 4970 4971 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4969 def model @model end |
#num_bytes ⇒ Fixnum
[Output-only] The size of this table in bytes, excluding any data in the
streaming buffer.
Corresponds to the JSON property numBytes
4975 4976 4977 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4975 def num_bytes @num_bytes end |
#num_long_term_bytes ⇒ Fixnum
[Output-only] The number of bytes in the table that are considered "long-term
storage".
Corresponds to the JSON property numLongTermBytes
4981 4982 4983 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4981 def num_long_term_bytes @num_long_term_bytes end |
#num_physical_bytes ⇒ Fixnum
[Output-only] [TrustedTester] The physical size of this table in bytes,
excluding any data in the streaming buffer. This includes compression and
storage used for time travel.
Corresponds to the JSON property numPhysicalBytes
4988 4989 4990 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4988 def num_physical_bytes @num_physical_bytes end |
#num_rows ⇒ Fixnum
[Output-only] The number of rows of data in this table, excluding any data in
the streaming buffer.
Corresponds to the JSON property numRows
4994 4995 4996 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4994 def num_rows @num_rows end |
#range_partitioning ⇒ Google::Apis::BigqueryV2::RangePartitioning
[TrustedTester] Range partitioning specification for this table. Only one of
timePartitioning and rangePartitioning should be specified.
Corresponds to the JSON property rangePartitioning
5000 5001 5002 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5000 def range_partitioning @range_partitioning end |
#require_partition_filter ⇒ Boolean Also known as: require_partition_filter?
[Optional] If set to true, queries over this table require a partition filter
that can be used for partition elimination to be specified.
Corresponds to the JSON property requirePartitionFilter
5006 5007 5008 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5006 def require_partition_filter @require_partition_filter end |
#schema ⇒ Google::Apis::BigqueryV2::TableSchema
[Optional] Describes the schema of this table.
Corresponds to the JSON property schema
5012 5013 5014 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5012 def schema @schema end |
#self_link ⇒ String
[Output-only] A URL that can be used to access this resource again.
Corresponds to the JSON property selfLink
5017 5018 5019 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5017 def self_link @self_link end |
#streaming_buffer ⇒ Google::Apis::BigqueryV2::Streamingbuffer
[Output-only] Contains information regarding this table's streaming buffer, if
one is present. This field will be absent if the table is not being streamed
to or if there is no data in the streaming buffer.
Corresponds to the JSON property streamingBuffer
5024 5025 5026 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5024 def streaming_buffer @streaming_buffer end |
#table_reference ⇒ Google::Apis::BigqueryV2::TableReference
[Required] Reference describing the ID of this table.
Corresponds to the JSON property tableReference
5029 5030 5031 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5029 def table_reference @table_reference end |
#time_partitioning ⇒ Google::Apis::BigqueryV2::TimePartitioning
Time-based partitioning specification for this table. Only one of
timePartitioning and rangePartitioning should be specified.
Corresponds to the JSON property timePartitioning
5035 5036 5037 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5035 def time_partitioning @time_partitioning end |
#type ⇒ String
[Output-only] Describes the table type. The following values are supported:
TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [
TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted.
EXTERNAL: A table that references data stored in an external storage system,
such as Google Cloud Storage. The default value is TABLE.
Corresponds to the JSON property type
5044 5045 5046 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5044 def type @type end |
#view ⇒ Google::Apis::BigqueryV2::ViewDefinition
[Optional] The view definition.
Corresponds to the JSON property view
5049 5050 5051 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5049 def view @view end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 5056 def update!(**args) @clustering = args[:clustering] if args.key?(:clustering) @creation_time = args[:creation_time] if args.key?(:creation_time) @description = args[:description] if args.key?(:description) @encryption_configuration = args[:encryption_configuration] if args.key?(:encryption_configuration) @etag = args[:etag] if args.key?(:etag) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) @external_data_configuration = args[:external_data_configuration] if args.key?(:external_data_configuration) @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) @materialized_view = args[:materialized_view] if args.key?(:materialized_view) @model = args[:model] if args.key?(:model) @num_bytes = args[:num_bytes] if args.key?(:num_bytes) @num_long_term_bytes = args[:num_long_term_bytes] if args.key?(:num_long_term_bytes) @num_physical_bytes = args[:num_physical_bytes] if args.key?(:num_physical_bytes) @num_rows = args[:num_rows] if args.key?(:num_rows) @range_partitioning = args[:range_partitioning] if args.key?(:range_partitioning) @require_partition_filter = args[:require_partition_filter] if args.key?(:require_partition_filter) @schema = args[:schema] if args.key?(:schema) @self_link = args[:self_link] if args.key?(:self_link) @streaming_buffer = args[:streaming_buffer] if args.key?(:streaming_buffer) @table_reference = args[:table_reference] if args.key?(:table_reference) @time_partitioning = args[:time_partitioning] if args.key?(:time_partitioning) @type = args[:type] if args.key?(:type) @view = args[:view] if args.key?(:view) end |