Google Cloud Data Catalog V1 Client - Class BigQueryDateShardedSpec (1.4.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class BigQueryDateShardedSpec.

Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

Generated from protobuf message google.cloud.datacatalog.v1.BigQueryDateShardedSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dataset string

Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.

↳ table_prefix string

Output only. The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD. For example, for the MyTable20180101 shard, the table_prefix is MyTable.

↳ shard_count int|string

Output only. Total number of shards.

↳ latest_shard_resource string

Output only. BigQuery resource name of the latest shard.

getDataset

Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.

Returns
TypeDescription
string

setDataset

Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTablePrefix

Output only. The table name prefix of the shards.

The name of any given shard is [table_prefix]YYYYMMDD. For example, for the MyTable20180101 shard, the table_prefix is MyTable.

Returns
TypeDescription
string

setTablePrefix

Output only. The table name prefix of the shards.

The name of any given shard is [table_prefix]YYYYMMDD. For example, for the MyTable20180101 shard, the table_prefix is MyTable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getShardCount

Output only. Total number of shards.

Returns
TypeDescription
int|string

setShardCount

Output only. Total number of shards.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getLatestShardResource

Output only. BigQuery resource name of the latest shard.

Returns
TypeDescription
string

setLatestShardResource

Output only. BigQuery resource name of the latest shard.

Parameter
NameDescription
var string
Returns
TypeDescription
$this