Package google.bigtable.admin.v2

StandardReadRemoteWrites

How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.

CheckConsistencyRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Fields

name

string

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.checkConsistency

consistency_token

string

Required. The token created using GenerateConsistencyToken for the Table.

Union field mode . Which type of read needs to consistently observe which type of write? Default: standard_read_remote_writes mode can be only one of the following:

standard_read_remote_writes

Checks that reads using an app profile with StandardIsolation can see all writes committed before the token was created, even if the read and write target different clusters.

data_boost_read_local_writes

DataBoostReadLocalWrites

Checks that reads using an app profile with DataBoostIsolationReadOnly can see all writes committed before the token was created, but only if the read and write target the same cluster.

CheckConsistencyResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Fields

Fields
`consistent`	`bool` True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.

consistent

bool

True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.

Cluster

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance .

Fields

name

string

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]* .

location

string

Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone} .

state

State

Output only. The current state of the cluster.

serve_nodes

int32

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

node_scaling_factor

NodeScalingFactor

Immutable. The node scaling factor of this cluster.

default_storage_type

StorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

encryption_config

EncryptionConfig

Immutable. The encryption configuration for CMEK-protected clusters.

Union field config .

config can be only one of the following:

cluster_config

ClusterConfig

Configuration for this cluster.

ClusterAutoscalingConfig

Autoscaling config for a cluster.

Fields

Fields
`autoscaling_limits`	`AutoscalingLimits` Required. Autoscaling limits for this cluster.
`autoscaling_targets`	`AutoscalingTargets` Required. Autoscaling targets for this cluster.

autoscaling_limits

AutoscalingLimits

Required. Autoscaling limits for this cluster.

autoscaling_targets

AutoscalingTargets

Required. Autoscaling targets for this cluster.

ClusterConfig

Configuration for a cluster.

Fields

Fields
`cluster_autoscaling_config`	`ClusterAutoscalingConfig` Autoscaling configuration for this cluster.

cluster_autoscaling_config

ClusterAutoscalingConfig

Autoscaling configuration for this cluster.

EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

Fields

Fields
`kms_key_name`	`string` Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`

kms_key_name

string

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

NodeScalingFactor

Possible node scaling factors of the clusters. Node scaling delivers better latency and more throughput by removing node boundaries.

Enums
`NODE_SCALING_FACTOR_UNSPECIFIED`	No node scaling specified. Defaults to NODE_SCALING_FACTOR_1X.
`NODE_SCALING_FACTOR_1X`	The cluster is running with a scaling factor of 1.
`NODE_SCALING_FACTOR_2X`	The cluster is running with a scaling factor of 2. All node count values must be in increments of 2 with this scaling factor enabled, otherwise an INVALID_ARGUMENT error will be returned.

State

Possible states of a cluster.

Enums
`STATE_NOT_KNOWN`	The state of the cluster could not be determined.
`READY`	The cluster has been successfully created and is ready to serve requests.
`CREATING`	The cluster is currently being created, and may be destroyed if the creation process encounters an error. A cluster may not be able to serve requests while being created.
`RESIZING`	The cluster is currently being resized, and may revert to its previous node count if the process encounters an error. A cluster is still capable of serving requests while being resized, but may exhibit performance as if its number of allocated nodes is between the starting and requested states.
`DISABLED`	The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.

ColumnFamily

A set of columns within a table which share a common configuration.

Fields

Fields
`gc_rule`	`GcRule` Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
`stats`	`ColumnFamilyStats` Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above.
`value_type`	`Type` The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate` , written data must be compatible with: * `value_type.input_type` for `AddInput` mutations

gc_rule

GcRule

Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes.

NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

stats

ColumnFamilyStats

Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above.

value_type

Type

The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

For now, only the Aggregate type is supported.

Aggregate can only be set at family creation and is immutable afterwards.

If value_type is Aggregate , written data must be compatible with: * value_type.input_type for AddInput mutations

ColumnFamilyStats

Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information.

Everything below is approximate, unless otherwise specified.

Fields

average_columns_per_row

double

How many column qualifiers are present in this column family, averaged over all rows in the table.

e.g. For column family "family" in a table with 3 rows:

A row with cells in "family:col" and "other:col" (1 column in "family")
A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family")
A row with cells in "other:col" (0 columns in "family", "family" not present)

would report (1 + 2 + 0)/3 = 1.5 in this field.

average_cells_per_column

double

How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family.

e.g. For column family "family" in a table with 3 rows:

A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family")
A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family")
A row with 3 cells in "other:col" (0 columns in "family", "family" not present)

would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field.

logical_data_bytes

int64

How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).

CopyBackupMetadata

Metadata type for the google.longrunning.Operation returned by CopyBackup .

Fields

name

string

The name of the backup being created through the copy operation. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup> .

source_backup_info

BackupInfo

Information about the source backup that is being copied from.

progress

OperationProgress

The progress of the CopyBackup operation.

CopyBackupRequest

The request for CopyBackup .

Fields

parent

string

Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.backups.create

backup_id

string

Required. The id of the new backup. The backup_id along with parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id} . This string must be between 1 and 50 characters in length and match the regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.

source_backup

string

Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup> .

Authorization requires the following IAM permission on the specified resource sourceBackup :

bigtable.backups.read

expire_time

CreateAuthorizedViewRequest

Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

CreateAppProfileRequest

Request message for BigtableInstanceAdmin.CreateAppProfile.

Fields

parent

string

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.appProfiles.create

app_profile_id

string

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile .

app_profile

AppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

ignore_warnings

bool

If true, ignore safety checks when creating the app profile.

CreateAuthorizedViewMetadata

The metadata for the Operation returned by CreateAuthorizedView.

Fields

original_request

The request that prompted the initiation of this CreateAuthorizedView operation.

request_time

The time at which the original request was received.

finish_time

The time at which the operation failed or was completed successfully.

CreateAuthorizedViewRequest

The request for CreateAuthorizedView

Fields

parent

string

Required. This is the name of the table the AuthorizedView belongs to. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.authorizedViews.create

authorized_view_id

string

Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The authorized_view_id appended to parent forms the full AuthorizedView name of the form projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view} .

authorized_view

AuthorizedView

Required. The AuthorizedView to create.

CreateBackupMetadata

Metadata type for the operation returned by CreateBackup .

Fields
`name`	`string` The name of the backup being created.
`source_table`	`string` The name of the table the backup is created from.
`start_time`	`Timestamp` The time at which this operation started.
`end_time`	`Timestamp` If set, the time at which this operation finished or was cancelled.

CreateBackupRequest

The request for CreateBackup .

Fields

parent

string

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .

Authorization requires one or more of the following IAM permissions on the specified resource parent :

bigtable.backups.create
bigtable.tables.readRows

backup_id

string

Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id} . This string must be between 1 and 50 characters in length and match the regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.

backup

Backup

Required. The backup to create.

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

Fields
`original_request`	`CreateClusterRequest` The request that prompted the initiation of this CreateCluster operation.
`request_time`	`Timestamp` The time at which the original request was received.
`finish_time`	`Timestamp` The time at which the operation failed or was completed successfully.
`tables`	`map<string, TableProgress >` Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>` . Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far.

TableProgress

Progress info for copying a table's data to the new cluster.

Fields

estimated_size_bytes

int64

Estimate of the size of the table to be copied.

estimated_copied_bytes

int64

Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED.

state

State

State

Enums
`STATE_UNSPECIFIED`
`PENDING`	The table has not yet begun copying to the new cluster.
`COPYING`	The table is actively being copied to the new cluster.
`COMPLETED`	The table has been fully copied to the new cluster.
`CANCELLED`	The table was deleted before it finished copying to the new cluster. Note that tables deleted after completion will stay marked as COMPLETED, not CANCELLED.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

Fields

parent

string

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.clusters.create

cluster_id

string

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster .

cluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

Fields

original_request

CreateInstanceRequest

The request that prompted the initiation of this CreateInstance operation.

request_time

The time at which the original request was received.

finish_time

CreateLogicalViewRequest

The time at which the operation failed or was completed successfully.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

Fields

parent

string

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project} .

Authorization requires one or more of the following IAM permissions on the specified resource parent :

bigtable.instances.create
bigtable.clusters.create

instance_id

string

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance .

instance

Instance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clusters

map<string, Cluster >

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster . Fields marked OutputOnly must be left blank.

CreateLogicalViewMetadata

The metadata for the Operation returned by CreateLogicalView.

Fields

original_request

The request that prompted the initiation of this CreateLogicalView operation.

start_time

The time at which this operation started.

end_time

CreateMaterializedViewRequest

If set, the time at which this operation finished or was canceled.

CreateLogicalViewRequest

Request message for BigtableInstanceAdmin.CreateLogicalView.

Fields

parent

string

Required. The parent instance where this logical view will be created. Format: projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.logicalViews.create

logical_view_id

string

Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.

logical_view

LogicalView

Required. The logical view to create.

CreateMaterializedViewMetadata

The metadata for the Operation returned by CreateMaterializedView.

Fields

original_request

The request that prompted the initiation of this CreateMaterializedView operation.

start_time

The time at which this operation started.

end_time

If set, the time at which this operation finished or was canceled.

CreateMaterializedViewRequest

Request message for BigtableInstanceAdmin.CreateMaterializedView.

Fields

parent

string

Required. The parent instance where this materialized view will be created. Format: projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.materializedViews.create

materialized_view_id

string

Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.

materialized_view

MaterializedView

Required. The materialized view to create.

CreateTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable

Fields

parent

string

Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.tables.create

table_id

string

Required. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar . Maximum 50 characters.

table

Table

Required. The Table to create.

initial_splits[]

Split

The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2 , three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ) .

Example:

Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
Key assignment:
- Tablet 1 [, apple) => {"a"}.
- Tablet 2 [apple, customer_1) => {"apple", "custom"}.
- Tablet 3 [customer_1, customer_2) => {"customer_1"}.
- Tablet 4 [customer_2, other) => {"customer_2"}.
- Tablet 5 [other, ) => {"other", "zz"}.

Split

An initial split point for a newly created table.

Fields

Fields
`key`	`bytes` Row key to use as an initial tablet boundary.

key

bytes

Row key to use as an initial tablet boundary.

DataBoostReadLocalWrites

This type has no fields.

Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.

DeleteAppProfileRequest

Request message for BigtableInstanceAdmin.DeleteAppProfile.

Fields

name

string

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.appProfiles.delete

ignore_warnings

bool

Required. If true, ignore safety checks when deleting the app profile.

DeleteAuthorizedViewRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView

Fields

name

string

Required. The unique name of the AuthorizedView to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.authorizedView.delete

etag

string

Optional. The current etag of the AuthorizedView. If an etag is provided and does not match the current etag of the AuthorizedView, deletion will be blocked and an ABORTED error will be returned.

DeleteBackupRequest

The request for DeleteBackup .

Fields

name

string

Required. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.backups.delete

DeleteClusterRequest

Request message for BigtableInstanceAdmin.DeleteCluster.

Fields

name

string

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.clusters.delete

DeleteInstanceRequest

Request message for BigtableInstanceAdmin.DeleteInstance.

Fields

name

string

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.instances.delete

DeleteLogicalViewRequest

Request message for BigtableInstanceAdmin.DeleteLogicalView.

Fields

name

string

Required. The unique name of the logical view to be deleted. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.logicalViews.delete

etag

string

Optional. The current etag of the logical view. If an etag is provided and does not match the current etag of the logical view, deletion will be blocked and an ABORTED error will be returned.

DeleteMaterializedViewRequest

Request message for BigtableInstanceAdmin.DeleteMaterializedView.

Fields

name

string

Required. The unique name of the materialized view to be deleted. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.materializedViews.delete

etag

string

Optional. The current etag of the materialized view. If an etag is provided and does not match the current etag of the materialized view, deletion will be blocked and an ABORTED error will be returned.

DeleteTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable

Fields

name

string

Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.delete

DropRowRangeRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange

Fields

name

string

Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.mutateRows

Union field target . Delete all rows or by prefix. target can be only one of the following:

row_key_prefix

bytes

Delete all rows that start with this row key prefix. Prefix cannot be zero length.

delete_all_data_from_table

bool

Delete all rows in the table. Setting this to false is a no-op.

EncryptionInfo

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

Fields

Fields
`encryption_type`	`EncryptionType` Output only. The type of encryption used to protect this resource.
`encryption_status`	`Status` Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
`kms_key_version`	`string` Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

encryption_type

EncryptionType

Output only. The type of encryption used to protect this resource.

encryption_status

Status

Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.

kms_key_version

string

Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

EncryptionType

Possible encryption types for a resource.

Enums
`ENCRYPTION_TYPE_UNSPECIFIED`	Encryption type was not specified, though data at rest remains encrypted.
`GOOGLE_DEFAULT_ENCRYPTION`	The data backing this resource is encrypted at rest with a key that is fully managed by Google. No key version or status will be populated. This is the default state.
`CUSTOMER_MANAGED_ENCRYPTION`	The data backing this resource is encrypted at rest with a key that is managed by the customer. The in-use version of the key and its status are populated for CMEK-protected tables. CMEK-protected backups are pinned to the key version that was in use at the time the backup was taken. This key version is populated but its status is not tracked and is reported as `UNKNOWN` .

GcRule

Rule for determining which cells to delete during garbage collection.

Fields

Union field rule . Garbage collection rules. rule can be only one of the following:

max_num_versions

int32

Delete all cells in a column except the most recent N.

max_age

Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

intersection

Intersection

Delete cells that would be deleted by every nested rule.

union

Union

Delete cells that would be deleted by any nested rule.

Intersection

A GcRule which deletes cells matching all of the given rules.

Fields

Fields
`rules[]`	`GcRule` Only delete cells which would be deleted by every element of `rules` .

rules[]

GcRule

Only delete cells which would be deleted by every element of rules .

Union

A GcRule which deletes cells matching any of the given rules.

Fields

Fields
`rules[]`	`GcRule` Delete cells which would be deleted by any element of `rules` .

rules[]

GcRule

Delete cells which would be deleted by any element of rules .

GenerateConsistencyTokenRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

Fields

name

string

Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.generateConsistencyToken

GenerateConsistencyTokenResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

Fields

Fields
`consistency_token`	`string` The generated consistency token.

consistency_token

string

The generated consistency token.

GetAppProfileRequest

Request message for BigtableInstanceAdmin.GetAppProfile.

Fields

name

string

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.appProfiles.get

GetAuthorizedViewRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView

Fields

name

string

Required. The unique name of the requested AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.authorizedView.get

view

ResponseView

Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC.

GetBackupRequest

The request for GetBackup .

Fields

name

string

Required. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.backups.get

GetClusterRequest

Request message for BigtableInstanceAdmin.GetCluster.

Fields

name

string

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.clusters.get

GetInstanceRequest

Request message for BigtableInstanceAdmin.GetInstance.

Fields

name

string

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.instances.get

GetLogicalViewRequest

Request message for BigtableInstanceAdmin.GetLogicalView.

Fields

name

string

Required. The unique name of the requested logical view. Values are of the form projects/{project}/instances/{instance}/logicalViews/{logical_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.logicalViews.get

GetMaterializedViewRequest

Request message for BigtableInstanceAdmin.GetMaterializedView.

Fields

name

string

Required. The unique name of the requested materialized view. Values are of the form projects/{project}/instances/{instance}/materializedViews/{materialized_view} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.materializedViews.get

GetTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetTable

Fields

name

string

Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.get

view

View

The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified.

HotTablet

A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization . A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.

Fields
`name`	`string` The unique name of the hot tablet. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*` .
`table_name`	`string` Name of the table that contains the tablet. Values are of the form `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*` .
`start_time`	`Timestamp` Output only. The start time of the hot tablet.
`end_time`	`Timestamp` Output only. The end time of the hot tablet.
`start_key`	`string` Tablet Start Key (inclusive).
`end_key`	`string` Tablet End Key (inclusive).
`node_cpu_usage_percent`	`float` Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).

Instance

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Fields

name

string

The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9] .

display_name

string

Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

state

State

Output only. The current state of the instance.

type

Type

The type of the instance. Defaults to PRODUCTION .

labels

map<string, string>

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} .
Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} .
No more than 64 labels can be associated with a given resource.
Keys and values must both be under 128 bytes.

create_time

Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 .

satisfies_pzs

bool

Output only. Reserved for future use.

satisfies_pzi

bool

Output only. Reserved for future use.

State

Possible states of an instance.

Enums
`STATE_NOT_KNOWN`	The state of the instance could not be determined.
`READY`	The instance has been successfully created and can serve requests to its tables.
`CREATING`	The instance is currently being created, and may be destroyed if the creation process encounters an error.

Type

The type of the instance.

Enums
`TYPE_UNSPECIFIED`	The type of the instance is unspecified. If set when creating an instance, a `PRODUCTION` instance will be created. If set when updating an instance, the type will be left unchanged.
`PRODUCTION`	An instance meant for production use. `serve_nodes` must be set on the cluster.
`DEVELOPMENT`	DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

ListAppProfilesRequest

Request message for BigtableInstanceAdmin.ListAppProfiles.

Fields

parent

string

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/- .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.appProfiles.list

page_size

int32

Maximum number of results per page.

A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.

Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

page_token

string

The value of next_page_token returned by a previous call.

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

Fields

Fields
`app_profiles[]`	`AppProfile` The list of requested app profiles.
`next_page_token`	`string` Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
`failed_locations[]`	`string` Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles` . Values are of the form `projects/<project>/locations/<zone_id>`

app_profiles[]

AppProfile

The list of requested app profiles.

next_page_token

string

Set if not all app profiles could be returned in a single response. Pass this value to page_token in another request to get the next page of results.

failed_locations[]

string

Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from app_profiles . Values are of the form projects/<project>/locations/<zone_id>

ListAuthorizedViewsRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews

Fields

parent

string

Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.authorizedViews.list

page_size

int32

Optional. Maximum number of results per page.

A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.

Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

page_token

string

Optional. The value of next_page_token returned by a previous call.

view

ResponseView

Optional. The resource_view to be applied to the returned AuthorizedViews' fields. Default to NAME_ONLY.

ListAuthorizedViewsResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews

Fields

Fields
`authorized_views[]`	`AuthorizedView` The AuthorizedViews present in the requested table.
`next_page_token`	`string` Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.

authorized_views[]

AuthorizedView

The AuthorizedViews present in the requested table.

next_page_token

string

Set if not all tables could be returned in a single response. Pass this value to page_token in another request to get the next page of results.

ListBackupsRequest

The request for ListBackups .

Fields

parent

string

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/- .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.backups.list

filter

string

A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive.

The fields eligible for filtering are:

name
source_table
state
start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
end_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
size_bytes

To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:

name:"exact" --> The backup's name is the string "exact".
name:howl --> The backup's name contains the string "howl".
source_table:prod --> The source_table's name contains the string "prod".
state:CREATING --> The backup is pending creation.
state:READY --> The backup is fully created and ready for use.
(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.
size_bytes > 10000000000 --> The backup's size is greater than 10GB

order_by

string

An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup . The full syntax is described at https://aip.dev/132#ordering .

Fields supported are:

name
source_table
expire_time
start_time
end_time
size_bytes
state

For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant.

If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

page_size

int32

Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

page_token

string

If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter .

ListBackupsResponse

The response for ListBackups .

Fields

Fields
`backups[]`	`Backup` The list of matching backups.
`next_page_token`	`string` `next_page_token` can be sent in a subsequent `ListBackups` call to fetch more of the matching backups.

backups[]

Backup

The list of matching backups.

next_page_token

string

next_page_token can be sent in a subsequent ListBackups call to fetch more of the matching backups.

ListClustersRequest

Request message for BigtableInstanceAdmin.ListClusters.

Fields

parent

string

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/- .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.clusters.list

page_token

string

DEPRECATED: This field is unused and ignored.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

Fields

Fields
`clusters[]`	`Cluster` The list of requested clusters.
`failed_locations[]`	`string` Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters` , or may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>`
`next_page_token`	`string` DEPRECATED: This field is unused and ignored.

clusters[]

The list of requested clusters.

failed_locations[]

string

Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from clusters , or may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

next_page_token

string

DEPRECATED: This field is unused and ignored.

ListHotTabletsRequest

Request message for BigtableInstanceAdmin.ListHotTablets.

Fields

parent

string

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.clusters.listHotTablets

start_time

The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.

end_time

The end time to list hot tablets.

page_size

int32

Maximum number of results per page.

A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.

Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

page_token

string

The value of next_page_token returned by a previous call.

ListHotTabletsResponse

Response message for BigtableInstanceAdmin.ListHotTablets.

Fields

Fields
`hot_tablets[]`	`HotTablet` List of hot tablets in the tables of the requested cluster that fall within the requested time range. Hot tablets are ordered by node cpu usage percent. If there are multiple hot tablets that correspond to the same tablet within a 15-minute interval, only the hot tablet with the highest node cpu usage will be included in the response.
`next_page_token`	`string` Set if not all hot tablets could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.

hot_tablets[]

HotTablet

List of hot tablets in the tables of the requested cluster that fall within the requested time range. Hot tablets are ordered by node cpu usage percent. If there are multiple hot tablets that correspond to the same tablet within a 15-minute interval, only the hot tablet with the highest node cpu usage will be included in the response.

next_page_token

string

Set if not all hot tablets could be returned in a single response. Pass this value to page_token in another request to get the next page of results.

ListInstancesRequest

Request message for BigtableInstanceAdmin.ListInstances.

Fields

parent

string

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.instances.list

page_token

string

DEPRECATED: This field is unused and ignored.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

Fields

Fields
`instances[]`	`Instance` The list of requested instances.
`failed_locations[]`	`string` Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances` , and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>`
`next_page_token`	`string` DEPRECATED: This field is unused and ignored.

instances[]

Instance

The list of requested instances.

failed_locations[]

string

Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from instances , and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

next_page_token

string

DEPRECATED: This field is unused and ignored.

ListLogicalViewsRequest

Request message for BigtableInstanceAdmin.ListLogicalViews.

Fields

parent

string

Required. The unique name of the instance for which the list of logical views is requested. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.logicalViews.list

page_size

int32

Optional. The maximum number of logical views to return. The service may return fewer than this value

page_token

string

Optional. A page token, received from a previous ListLogicalViews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListLogicalViews must match the call that provided the page token.

ListLogicalViewsResponse

Response message for BigtableInstanceAdmin.ListLogicalViews.

Fields

Fields
`logical_views[]`	`LogicalView` The list of requested logical views.
`next_page_token`	`string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

logical_views[]

LogicalView

The list of requested logical views.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListMaterializedViewsRequest

Request message for BigtableInstanceAdmin.ListMaterializedViews.

Fields

parent

string

Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.materializedViews.list

page_size

int32

Optional. The maximum number of materialized views to return. The service may return fewer than this value

page_token

string

Optional. A page token, received from a previous ListMaterializedViews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMaterializedViews must match the call that provided the page token.

ListMaterializedViewsResponse

Response message for BigtableInstanceAdmin.ListMaterializedViews.

Fields

Fields
`materialized_views[]`	`MaterializedView` The list of requested materialized views.
`next_page_token`	`string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

materialized_views[]

MaterializedView

The list of requested materialized views.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListTablesRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables

Fields

parent

string

Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance} .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.tables.list

view

View

The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.

page_size

int32

Maximum number of results per page.

A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.

Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

page_token

string

The value of next_page_token returned by a previous call.

ListTablesResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables

Fields

Fields
`tables[]`	`Table` The tables present in the requested instance.
`next_page_token`	`string` Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.

tables[]

Table

The tables present in the requested instance.

next_page_token

string

Set if not all tables could be returned in a single response. Pass this value to page_token in another request to get the next page of results.

LogicalView

A SQL logical view object that can be referenced in SQL queries.

Fields

Fields
`name`	`string` Identifier. The unique name of the logical view. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`
`query`	`string` Required. The logical view's select query.
`etag`	`string` Optional. The etag for this logical view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.

name

string

Identifier. The unique name of the logical view. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view}

query

string

Required. The logical view's select query.

etag

string

Optional. The etag for this logical view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.

MaterializedView

A materialized view object that can be referenced in SQL queries.

Fields
`name`	`string` Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`
`query`	`string` Required. Immutable. The materialized view's select query.
`etag`	`string` Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
`deletion_protection`	`bool` Set to true to make the MaterializedView protected against deletion.

ModifyColumnFamiliesRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

Fields

name

string

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.update

modifications[]

Modification

Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

ignore_warnings

bool

Optional. If true, ignore safety checks when modifying the column families.

Modification

A create, update, or delete of a particular column family.

Fields

id

string

The ID of the column family to be modified.

update_mask

Optional. A mask specifying which fields (e.g. gc_rule ) in the update mod should be updated, ignored for other modification types. If unset or empty, we treat it as updating gc_rule to be backward compatible.

Union field mod . Column family modifications. mod can be only one of the following:

create

ColumnFamily

Create a new column family with the specified schema, or fail if one already exists with the given ID.

update

ColumnFamily

Update an existing column family to the specified schema, or fail if no column family exists with the given ID.

drop

bool

Drop (delete) the column family with the given ID, or fail if no such family exists.

OperationProgress

Encapsulates progress related information for a Cloud Bigtable long running operation.

Fields

progress_percent

int32

Percent completion of the operation. Values are between 0 and 100 inclusive.

start_time

Time the request was received.

end_time

If set, the time at which this operation failed or was completed successfully.

OptimizeRestoredTableMetadata

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored table. This long-running operation is automatically created by the system after the successful completion of a table restore, and cannot be cancelled.

Fields

name

string

Name of the restored table being optimized.

progress

OperationProgress

The progress of the post-restore optimizations.

PartialUpdateClusterMetadata

The metadata for the Operation returned by PartialUpdateCluster.

Fields

request_time

The time at which the original request was received.

finish_time

PartialUpdateClusterRequest

The time at which the operation failed or was completed successfully.

original_request

The original request for PartialUpdateCluster.

PartialUpdateClusterRequest

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

Fields

cluster

Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.

update_mask

Required. The subset of Cluster fields which should be replaced.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

Fields

instance

Instance

Required. The Instance which will (partially) replace the current value.

update_mask

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

RestoreInfo

Information about a table restore.

Fields

source_type

RestoreSourceType

The type of the restore source.

Union field source_info . Information about the source used to restore the table. source_info can be only one of the following:

backup_info

BackupInfo

Information about the backup used to restore the table. The backup may no longer exist.

RestoreSourceType

Indicates the type of the restore source.

Enums
`RESTORE_SOURCE_TYPE_UNSPECIFIED`	No restore associated.
`BACKUP`	A backup was used as the source of the restore.

RestoreTableMetadata

Metadata type for the long-running operation returned by RestoreTable .

Fields

name

string

Name of the table being created and restored to.

source_type

RestoreSourceType

The type of the restore source.

optimize_table_operation_name

string

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored table. The metadata type of the long-running operation is OptimizeRestoredTableMetadata . The response type is Empty . This long-running operation may be automatically created by the system if applicable after the RestoreTable long-running operation completes successfully. This operation may not be created if the table is already optimized or the restore was not successful.

progress

OperationProgress

The progress of the RestoreTable operation.

Union field source_info . Information about the source used to restore the table, as specified by source in

 RestoreTableRequest

. source_info can be only one of the following:

backup_info

BackupInfo

RestoreTableRequest

The request for RestoreTable .

Fields

parent

string

Required. The name of the instance in which to create the restored table. Values are of the form projects/<project>/instances/<instance> .

Authorization requires the following IAM permission on the specified resource parent :

bigtable.tables.create

table_id

string

Required. The id of the table to create and restore to. This table must not already exist. The table_id appended to parent forms the full table name of the form projects/<project>/instances/<instance>/tables/<table_id> .

Union field source . Required. The source from which to restore. source can be only one of the following:

backup

string

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup> .

Authorization requires the following IAM permission on the specified resource backup :

bigtable.backups.restore

StandardReadRemoteWrites

This type has no fields.

Checks that all writes before the consistency token was generated are replicated in every cluster and readable.

StorageType

Storage media types for persisting Bigtable data.

Enums
`STORAGE_TYPE_UNSPECIFIED`	The user did not specify a storage type.
`SSD`	Flash (SSD) storage should be used.
`HDD`	Magnetic drive (HDD) storage should be used.

Table

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

Fields

name

string

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]* . Views: NAME_ONLY , SCHEMA_VIEW , REPLICATION_VIEW , STATS_VIEW , FULL

cluster_states

map<string, ClusterState >

Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN replication_status . Views: REPLICATION_VIEW , ENCRYPTION_VIEW , FULL

column_families

map<string, ColumnFamily >

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW , STATS_VIEW , FULL

granularity

TimestampGranularity

Immutable. The granularity (i.e. MILLIS ) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS . Views: SCHEMA_VIEW , FULL .

restore_info

RestoreInfo

Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.

change_stream_config

ChangeStreamConfig

If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

deletion_protection

bool

Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:

The table.
The column families in the table.
The instance containing the table.

Note one can still delete the data stored in the table through Data APIs.

stats

TableStats

Output only. Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.

row_key_schema

Struct

The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API.

For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key.

For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } }

The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | ------------------------------------------------------/

The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp".

The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the ignore_warnings flag to true , since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported.

Union field automated_backup_config .

automated_backup_config can be only one of the following:

automated_backup_policy

AutomatedBackupPolicy

If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.

AutomatedBackupPolicy

Defines an automated backup policy for a table

Fields

retention_period

Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.

frequency

How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.

ClusterState

The state of a table's data in a particular cluster.

Fields

replication_state

ReplicationState

Output only. The state of replication for the table in this cluster.

encryption_info[]

EncryptionInfo

Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.

ReplicationState

Table replication states.

Enums
`STATE_NOT_KNOWN`	The replication state of the table is unknown in this cluster.
`INITIALIZING`	The cluster was recently created, and the table must finish copying over pre-existing data from other clusters before it can begin receiving live replication updates and serving Data API requests.
`PLANNED_MAINTENANCE`	The table is temporarily unable to serve Data API requests from this cluster due to planned internal maintenance.
`UNPLANNED_MAINTENANCE`	The table is temporarily unable to serve Data API requests from this cluster due to unplanned or emergency maintenance.
`READY`	The table can serve Data API requests from this cluster. Depending on replication delay, reads may not immediately reflect the state of the table in other clusters.
`READY_OPTIMIZING`	The table is fully created and ready for use after a restore, and is being optimized for performance. When optimizations are complete, the table will transition to `READY` state.

TimestampGranularity

Possible timestamp granularities to use when keeping multiple versions of data in a table.

Enums
`TIMESTAMP_GRANULARITY_UNSPECIFIED`	The user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
`MILLIS`	The table keeps data versioned at a granularity of 1ms.

View

Defines a view over a table's fields.

Enums
`VIEW_UNSPECIFIED`	Uses the default view for each method as documented in its request.
`NAME_ONLY`	Only populates `name` .
`SCHEMA_VIEW`	Only populates `name` and fields related to the table's schema.
`REPLICATION_VIEW`	Only populates `name` and fields related to the table's replication state.
`ENCRYPTION_VIEW`	Only populates `name` and fields related to the table's encryption state.
`STATS_VIEW`	Only populates `name` and fields related to the table's stats (e.g. TableStats and ColumnFamilyStats).
`FULL`	Populates all fields except for stats. See STATS_VIEW to request stats.

TableStats

Approximate statistics related to a table.

These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate.

IMPORTANT: Everything below is approximate, unless otherwise specified.

Fields

row_count

int64

How many rows are in the table.

average_columns_per_row

double

How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table.

e.g. A table with 2 rows:

A row with cells in "family:col" and "other:col" (2 distinct columns)
A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns)

would report (2 + 3)/2 = 2.5 in this field.

average_cells_per_column

double

How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table.

e.g. A table with 2 rows:

A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns)
A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns)

would report (4 + 15)/(2 + 3) = 3.8 in this field.

logical_data_bytes

int64

This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).

Type

Type represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features.

For compatibility with Bigtable's existing untyped APIs, each Type includes an Encoding which describes how to convert to or from the underlying data.

Each encoding can operate in one of two modes:

Sorted: In this mode, Bigtable guarantees that Encode(X) <= Encode(Y) if and only if X <= Y . This is useful anywhere sort order is important, for example when encoding keys.
Distinct: In this mode, Bigtable guarantees that if X != Y then Encode(X) != Encode(Y) . However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value.

The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because INT64(1) > INT64(-1) , but STRING("-00001") > STRING("00001") .

Fields

Union field kind . The kind of type that this represents. kind can be only one of the following:

bytes_type

Bytes

Bytes

string_type

String

String

int64_type

Int64

Int64

float32_type

Float32

Float32

float64_type

Float64

Float64

bool_type

Bool

Bool

timestamp_type

HyperLogLogPlusPlusUniqueCount

Timestamp

date_type

Date

Date

aggregate_type

Aggregate

Aggregate

struct_type

Struct

Struct

array_type

Array

Array

map_type

Map

Map

Aggregate

A value that combines incremental updates into a summarized value.

Data is never directly written or read using type Aggregate . Writes provide either the input_type or state_type , and reads always return the state_type .

Fields

input_type

Type

Type of the inputs that are accumulated by this Aggregate . Use AddInput mutations to accumulate new inputs.

state_type

Type

Output only. Type that holds the internal accumulator state for the Aggregate . This is a function of the input_type and aggregator chosen.

Union field aggregator . Which aggregator function to use. The configured types must match. aggregator can be only one of the following:

sum

Sum

Sum aggregator.

hllpp_unique_count

HyperLogLogPlusPlusUniqueCount aggregator.

max

Max

Max aggregator.

min

Min

Min aggregator.

HyperLogLogPlusPlusUniqueCount

This type has no fields.

Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: Int64 (the unique count estimate)

Max

This type has no fields.

Computes the max of the input values. Allowed input: Int64 State: same as input

Min

This type has no fields.

Computes the min of the input values. Allowed input: Int64 State: same as input

Sum

This type has no fields.

Computes the sum of the input values. Allowed input: Int64 State: same as input

Array

An ordered list of elements of a given type. Values of type Array are stored in Value.array_value .

Fields

element_type

Type

The type of the elements in the array. This must not be Array .

Bool

This type has no fields.

bool Values of type Bool are stored in Value.bool_value .

Bytes

Bytes Values of type Bytes are stored in Value.bytes_value .

Fields

encoding

The encoding to use when converting to or from lower level types.

Encoding

Rules used to convert to or from lower level types.

Fields

Union field encoding . Which encoding to use. encoding can be only one of the following:

raw

Raw

Use Raw encoding.

Raw

Leaves the value as-is.

Sorted mode: all values are supported.

Distinct mode: all values are supported.

Fields

escape_nulls

bool

If set, allows NULL values to be encoded as the empty string "".

The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended.

Date

This type has no fields.

Date Values of type Date are stored in Value.date_value .

Float32

This type has no fields.

Float32 Values of type Float32 are stored in Value.float_value .

Float64

This type has no fields.

Float64 Values of type Float64 are stored in Value.float_value .

Int64

Int64 Values of type Int64 are stored in Value.int_value .

Fields

encoding

The encoding to use when converting to or from lower level types.

Encoding

Rules used to convert to or from lower level types.

Fields

Union field encoding . Which encoding to use. encoding can be only one of the following:

big_endian_bytes

BigEndianBytes

Use BigEndianBytes encoding.

ordered_code_bytes

OrderedCodeBytes

Use OrderedCodeBytes encoding.

BigEndianBytes

Encodes the value as an 8-byte big-endian two's complement value.

Sorted mode: non-negative values are supported.

Distinct mode: all values are supported.

Compatible with:

BigQuery BINARY encoding
HBase Bytes.toBytes
Java ByteBuffer.putLong() with ByteOrder.BIG_ENDIAN

Fields

bytes_type
 (deprecated)

Bytes

Deprecated: ignored if set.

OrderedCodeBytes

This type has no fields.

Encodes the value in a variable length binary format of up to 10 bytes. Values that are closer to zero use fewer bytes.

Sorted mode: all values are supported.

Distinct mode: all values are supported.

Map

A mapping of keys to values of a given type. Values of type Map are stored in a Value.array_value where each entry is another Value.array_value with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the last value takes precedence.

Fields

key_type

Type

The type of a map key. Only Bytes , String , and Int64 are allowed as key types.

value_type

Type

The type of the values in a map.

String

String Values of type String are stored in Value.string_value .

Fields

encoding

The encoding to use when converting to or from lower level types.

Encoding

Rules used to convert to or from lower level types.

Fields

Union field encoding . Which encoding to use. encoding can be only one of the following:

utf8_raw
 (deprecated)

Utf8Raw

Deprecated: if set, converts to an empty utf8_bytes .

utf8_bytes

Utf8Bytes

Use Utf8Bytes encoding.

Utf8Bytes

UTF-8 encoding.

Sorted mode: - All values are supported. - Code point order is preserved.

Distinct mode: all values are supported.

Compatible with:

BigQuery TEXT encoding
HBase Bytes.toBytes
Java String#getBytes(StandardCharsets.UTF_8)

Fields

null_escape_char

string

Single-character escape sequence used to support NULL values.

If set, allows NULL values to be encoded as the empty string "".

The actual empty string, or any value where every character equals null_escape_char , has one more null_escape_char appended.

If null_escape_char is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode.

Utf8Raw

This type has no fields.

Deprecated: prefer the equivalent Utf8Bytes .

Struct

A structured data value, consisting of fields which map to dynamically typed values. Values of type Struct are stored in Value.array_value where entries are in the same order and number as field_types .

Fields

fields[]

Field

The names and types of the fields in this struct.

encoding

The encoding to use when converting to or from lower level types.

Encoding

Rules used to convert to or from lower level types.

Fields

Union field encoding . Which encoding to use. encoding can be only one of the following:

singleton

Singleton

Use Singleton encoding.

delimited_bytes

DelimitedBytes

Use DelimitedBytes encoding.

ordered_code_bytes

OrderedCodeBytes

User OrderedCodeBytes encoding.

DelimitedBytes

Fields are encoded independently and concatenated with a configurable delimiter in between.

A struct with no fields defined is encoded as a single delimiter .

Sorted mode:

Fields are encoded in sorted mode.
Encoded field values must not contain any bytes <= delimiter[0]
Element-wise order is preserved: A < B if A[0] < B[0] , or if A[0] == B[0] && A[1] < B[1] , etc. Strict prefixes sort first.

Distinct mode:

Fields are encoded in distinct mode.
Encoded field values must not contain delimiter[0] .

Fields

delimiter

bytes

Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters.

OrderedCodeBytes

This type has no fields.

Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between.

Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}.

Fields that encode to the empty string "" have special handling:

If every field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}.
Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}.

Examples:

STRUCT() -> "\00\00"
STRUCT("") -> "\00\00"
STRUCT("", "") -> "\00\00"
STRUCT("", "B") -> "\00\00" + "\00\01" + "B"
STRUCT("A", "") -> "A"
STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B"
STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"

Since null bytes are always escaped, this encoding can cause size blowup for encodings like Int64.BigEndianBytes that are likely to produce many such bytes.

Sorted mode:

Fields are encoded in sorted mode.
All values supported by the field encodings are allowed
Element-wise order is preserved: A < B if A[0] < B[0] , or if A[0] == B[0] && A[1] < B[1] , etc. Strict prefixes sort first.

Distinct mode:

Fields are encoded in distinct mode.
All values supported by the field encodings are allowed.

Singleton

This type has no fields.

Uses the encoding of fields[0].type as-is. Only valid if fields.size == 1 .

Field

A struct field and its type.

Fields

field_name

string

The field name (optional). Fields without a field_name are considered anonymous and cannot be referenced by name.

type

Type

The type of values in this field.

Timestamp

Timestamp Values of type Timestamp are stored in Value.timestamp_value .

Fields

encoding

The encoding to use when converting to or from lower level types.

Encoding

Rules used to convert to or from lower level types.

Fields

Union field encoding . Which encoding to use. encoding can be only one of the following:

unix_micros_int64

Encodes the number of microseconds since the Unix epoch using the given Int64 encoding. Values must be microsecond-aligned.

Compatible with:

Java Instant.truncatedTo() with ChronoUnit.MICROS

UndeleteTableMetadata

Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable .

Fields

name

string

The name of the table being restored.

start_time

The time at which this operation started.

end_time

If set, the time at which this operation finished or was cancelled.

UndeleteTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable

Fields

name

string

Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table} .

Authorization requires the following IAM permission on the specified resource name :

bigtable.tables.undelete

UpdateAppProfileMetadata

This type has no fields.

The metadata for the Operation returned by UpdateAppProfile.

UpdateAppProfileRequest

Request message for BigtableInstanceAdmin.UpdateAppProfile.

Fields

app_profile

AppProfile

Required. The app profile which will (partially) replace the current value.

update_mask

UpdateAuthorizedViewRequest

Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

ignore_warnings

bool

If true, ignore safety checks when updating the app profile.

UpdateAuthorizedViewMetadata

Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView .

Fields

original_request

The request that prompted the initiation of this UpdateAuthorizedView operation.

request_time

The time at which the original request was received.

finish_time

The time at which the operation failed or was completed successfully.

UpdateAuthorizedViewRequest

The request for UpdateAuthorizedView .

Fields

authorized_view

AuthorizedView

Required. The AuthorizedView to update. The name in authorized_view is used to identify the AuthorizedView. AuthorizedView name must in this format: projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view} .

Authorization requires the following IAM permission on the specified resource authorizedView :

bigtable.authorizedView.update

update_mask

Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value * means to overwrite all fields (including fields not set in the request).

ignore_warnings

bool

Optional. If true, ignore the safety checks when updating the AuthorizedView.

UpdateBackupRequest

The request for UpdateBackup .

Fields

backup

Backup

Required. The backup to update. backup.name , and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields:

backup.expire_time .
backup.hot_to_standard_time .

Authorization requires the following IAM permission on the specified resource backup :

bigtable.backups.update

update_mask

Required. A mask specifying which fields (e.g. expire_time ) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

Fields

original_request

The request that prompted the initiation of this UpdateCluster operation.

request_time

The time at which the original request was received.

finish_time

PartialUpdateInstanceRequest

The time at which the operation failed or was completed successfully.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

Fields

original_request

The request that prompted the initiation of this UpdateInstance operation.

request_time

The time at which the original request was received.

finish_time

UpdateLogicalViewRequest

The time at which the operation failed or was completed successfully.

UpdateLogicalViewMetadata

The metadata for the Operation returned by UpdateLogicalView.

Fields

original_request

The request that prompted the initiation of this UpdateLogicalView operation.

start_time

The time at which this operation was started.

end_time

If set, the time at which this operation finished or was canceled.

UpdateLogicalViewRequest

Request message for BigtableInstanceAdmin.UpdateLogicalView.

Fields

logical_view

LogicalView

Required. The logical view to update.

The logical view's name field is used to identify the view to update. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view} .

Authorization requires the following IAM permission on the specified resource logicalView :

bigtable.logicalViews.update

update_mask

UpdateMaterializedViewRequest

Optional. The list of fields to update.

UpdateMaterializedViewMetadata

The metadata for the Operation returned by UpdateMaterializedView.

Fields

original_request

The request that prompted the initiation of this UpdateMaterializedView operation.

start_time

The time at which this operation was started.

end_time

If set, the time at which this operation finished or was canceled.

UpdateMaterializedViewRequest

Request message for BigtableInstanceAdmin.UpdateMaterializedView.

Fields

materialized_view

MaterializedView

Required. The materialized view to update.

The materialized view's name field is used to identify the view to update. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view} .

Authorization requires the following IAM permission on the specified resource materializedView :

bigtable.materializedViews.update

update_mask

Optional. The list of fields to update.

UpdateTableMetadata

Metadata type for the operation returned by UpdateTable .

Fields

name

string

The name of the table being updated.

start_time

The time at which this operation started.

end_time

If set, the time at which this operation finished or was canceled.

UpdateTableRequest

The request for UpdateTable .

Fields

table

Table

Required. The table to update. The table's name field is used to identify the table to update.

Authorization requires the following IAM permission on the specified resource table :

bigtable.tables.update

update_mask