Index
BigtableInstanceAdmin(interface)BigtableTableAdmin(interface)AppProfile(message)AppProfile.DataBoostIsolationReadOnly(message)AppProfile.DataBoostIsolationReadOnly.ComputeBillingOwner(enum)AppProfile.MultiClusterRoutingUseAny(message)AppProfile.Priority(enum)AppProfile.SingleClusterRouting(message)AppProfile.StandardIsolation(message)AuthorizedView(message)AuthorizedView.FamilySubsets(message)AuthorizedView.ResponseView(enum)AuthorizedView.SubsetView(message)AutoscalingLimits(message)AutoscalingTargets(message)Backup(message)Backup.State(enum)BackupInfo(message)ChangeStreamConfig(message)CheckConsistencyRequest(message)CheckConsistencyResponse(message)Cluster(message)Cluster.ClusterAutoscalingConfig(message)Cluster.ClusterConfig(message)Cluster.EncryptionConfig(message)Cluster.State(enum)ColumnFamily(message)ColumnFamilyStats(message)CopyBackupMetadata(message)CopyBackupRequest(message)CreateAppProfileRequest(message)CreateAuthorizedViewMetadata(message)CreateAuthorizedViewRequest(message)CreateBackupMetadata(message)CreateBackupRequest(message)CreateClusterMetadata(message)CreateClusterMetadata.TableProgress(message)CreateClusterMetadata.TableProgress.State(enum)CreateClusterRequest(message)CreateInstanceMetadata(message)CreateInstanceRequest(message)CreateTableRequest(message)CreateTableRequest.Split(message)DataBoostReadLocalWrites(message)DeleteAppProfileRequest(message)DeleteAuthorizedViewRequest(message)DeleteBackupRequest(message)DeleteClusterRequest(message)DeleteInstanceRequest(message)DeleteTableRequest(message)DropRowRangeRequest(message)EncryptionInfo(message)EncryptionInfo.EncryptionType(enum)GcRule(message)GcRule.Intersection(message)GcRule.Union(message)GenerateConsistencyTokenRequest(message)GenerateConsistencyTokenResponse(message)GetAppProfileRequest(message)GetAuthorizedViewRequest(message)GetBackupRequest(message)GetClusterRequest(message)GetInstanceRequest(message)GetTableRequest(message)HotTablet(message)Instance(message)Instance.State(enum)Instance.Type(enum)ListAppProfilesRequest(message)ListAppProfilesResponse(message)ListAuthorizedViewsRequest(message)ListAuthorizedViewsResponse(message)ListBackupsRequest(message)ListBackupsResponse(message)ListClustersRequest(message)ListClustersResponse(message)ListHotTabletsRequest(message)ListHotTabletsResponse(message)ListInstancesRequest(message)ListInstancesResponse(message)ListTablesRequest(message)ListTablesResponse(message)ModifyColumnFamiliesRequest(message)ModifyColumnFamiliesRequest.Modification(message)OperationProgress(message)OptimizeRestoredTableMetadata(message)PartialUpdateClusterMetadata(message)PartialUpdateClusterRequest(message)PartialUpdateInstanceRequest(message)RestoreInfo(message)RestoreSourceType(enum)RestoreTableMetadata(message)RestoreTableRequest(message)StandardReadRemoteWrites(message)StorageType(enum)Table(message)Table.AutomatedBackupPolicy(message)Table.ClusterState(message)Table.ClusterState.ReplicationState(enum)Table.TimestampGranularity(enum)Table.View(enum)TableStats(message)Type(message)Type.Aggregate(message)Type.Aggregate.HyperLogLogPlusPlusUniqueCount(message)Type.Aggregate.Max(message)Type.Aggregate.Min(message)Type.Aggregate.Sum(message)Type.Array(message)Type.Bool(message)Type.Bytes(message)Type.Bytes.Encoding(message)Type.Bytes.Encoding.Raw(message)Type.Date(message)Type.Float32(message)Type.Float64(message)Type.Int64(message)Type.Int64.Encoding(message)Type.Int64.Encoding.BigEndianBytes(message)Type.Map(message)Type.String(message)Type.String.Encoding(message)Type.String.Encoding.Utf8Bytes(message)Type.String.Encoding.Utf8Raw(message)Type.Struct(message)Type.Struct.Field(message)Type.Timestamp(message)UndeleteTableMetadata(message)UndeleteTableRequest(message)UpdateAppProfileMetadata(message)UpdateAppProfileRequest(message)UpdateAuthorizedViewMetadata(message)UpdateAuthorizedViewRequest(message)UpdateBackupRequest(message)UpdateClusterMetadata(message)UpdateInstanceMetadata(message)UpdateTableMetadata(message)UpdateTableRequest(message)
BigtableInstanceAdmin
Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.
| CreateAppProfile |
|---|
|
Creates an app profile within an instance.
|
| CreateCluster |
|---|
|
Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
|
| CreateInstance |
|---|
|
Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
|
| DeleteAppProfile |
|---|
|
Deletes an app profile from an instance.
|
| DeleteCluster |
|---|
|
Deletes a cluster from an instance.
|
| DeleteInstance |
|---|
|
Delete an instance from a project.
|
| GetAppProfile |
|---|
|
Gets information about an app profile.
|
| GetCluster |
|---|
|
Gets information about a cluster.
|
| GetIamPolicy |
|---|
|
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
|
| GetInstance |
|---|
|
Gets information about an instance.
|
| ListAppProfiles |
|---|
|
Lists information about app profiles in an instance.
|
| ListClusters |
|---|
|
Lists information about clusters in an instance.
|
| ListHotTablets |
|---|
|
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
|
| ListInstances |
|---|
|
Lists information about instances in a project.
|
| PartialUpdateCluster |
|---|
|
Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
|
| PartialUpdateInstance |
|---|
|
Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
|
| SetIamPolicy |
|---|
|
Sets the access control policy on an instance resource. Replaces any existing policy.
|
| TestIamPermissions |
|---|
|
Returns permissions that the caller has on the specified instance resource.
|
| UpdateAppProfile |
|---|
|
Updates an app profile within an instance.
|
| UpdateCluster |
|---|
|
Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
|
| UpdateInstance |
|---|
|
Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
|
BigtableTableAdmin
Service for creating, configuring, and deleting Cloud Bigtable tables.
Provides access to the table schemas only, not the data stored within the tables.
| CheckConsistency |
|---|
|
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
|
| CopyBackup |
|---|
|
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
|
| CreateAuthorizedView |
|---|
|
Creates a new AuthorizedView in a table.
|
| CreateBackup |
|---|
|
Starts creating a new Cloud Bigtable Backup. The returned backup
|
| CreateTable |
|---|
|
Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
|
| DeleteAuthorizedView |
|---|
|
Permanently deletes a specified AuthorizedView.
|
| DeleteBackup |
|---|
|
Deletes a pending or completed Cloud Bigtable backup.
|
| DeleteTable |
|---|
|
Permanently deletes a specified table and all of its data.
|
| DropRowRange |
|---|
|
Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice.
|
| GenerateConsistencyToken |
|---|
|
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
|
| GetAuthorizedView |
|---|
|
Gets information from a specified AuthorizedView.
|
| GetBackup |
|---|
|
Gets metadata on a pending or completed Cloud Bigtable Backup.
|
| GetIamPolicy |
|---|
|
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
|
| GetTable |
|---|
|
Gets metadata information about the specified table.
|
| ListAuthorizedViews |
|---|
|
Lists all AuthorizedViews from a specific table.
|
| ListBackups |
|---|
|
Lists Cloud Bigtable backups. Returns both completed and pending backups.
|
| ListTables |
|---|
|
Lists all tables served from a specified instance.
|
| ModifyColumnFamilies |
|---|
|
Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
|
| RestoreTable |
|---|
|
Create a new table by restoring from a completed backup. The returned table
|
| SetIamPolicy |
|---|
|
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
|
| TestIamPermissions |
|---|
|
Returns permissions that the caller has on the specified Bigtable resource.
|
| UndeleteTable |
|---|
|
Restores a specified table which was accidentally deleted.
|
| UpdateAuthorizedView |
|---|
|
Updates an AuthorizedView in a table.
|
| UpdateBackup |
|---|
|
Updates a pending or completed Cloud Bigtable Backup.
|
| UpdateTable |
|---|
|
Updates a specified table.
|
AppProfile
A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
| Fields | |
|---|---|
name |
The unique name of the app profile. Values are of the form Authorization requires the following IAM permission on the specified resource
|
etag |
Strongly validated etag for optimistic concurrency control. Preserve the value returned from |
description |
Long form description of the use case for this AppProfile. |
Union field routing_policy. The routing policy for all read/write requests that use this app profile. A value must be explicitly set. routing_policy can be only one of the following: |
|
multi_cluster_routing_use_any |
Use a multi-cluster routing policy. |
single_cluster_routing |
Use a single-cluster routing policy. |
Union field isolation. Options for isolating this app profile's traffic from other use cases. isolation can be only one of the following: |
|
priority |
This field has been deprecated in favor of The priority of requests sent using this app profile. |
standard_isolation |
The standard options used for isolating this app profile's traffic from other use cases. |
data_boost_isolation_read_only |
Specifies that this app profile is intended for read-only usage via the Data Boost feature. |
DataBoostIsolationReadOnly
Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.
| Fields | |
|---|---|
compute_billing_owner |
The Compute Billing Owner for this Data Boost App Profile. |
ComputeBillingOwner
Compute Billing Owner specifies how usage should be accounted when using Data Boost. Compute Billing Owner also configures which Cloud Project is charged for relevant quota.
| Enums | |
|---|---|
COMPUTE_BILLING_OWNER_UNSPECIFIED |
Unspecified value. |
HOST_PAYS |
The host Cloud Project containing the targeted Bigtable Instance / Table pays for compute. |
MultiClusterRoutingUseAny
Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
| Fields | |
|---|---|
cluster_ids[] |
The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. |
Priority
Possible priorities for an app profile. Note that higher priority writes can sometimes queue behind lower priority writes to the same tablet, as writes must be strictly sequenced in the durability log.
| Enums | |
|---|---|
PRIORITY_UNSPECIFIED |
Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation. |
PRIORITY_LOW |
|
PRIORITY_MEDIUM |
|
PRIORITY_HIGH |
|
SingleClusterRouting
Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
| Fields | |
|---|---|
cluster_id |
The cluster to which read/write requests should be routed. |
allow_transactional_writes |
Whether or not |
StandardIsolation
Standard options for isolating this app profile's traffic from other use cases.
| Fields | |
|---|---|
priority |
The priority of requests sent using this app profile. |
AuthorizedView
An Authorized View of a Cloud Bigtable Table.
| Fields | |
|---|---|
name |
Identifier. The name of this AuthorizedView. Values are of the form |
etag |
The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. |
deletion_protection |
Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. |
Union field authorized_view. The type of this AuthorizedView. authorized_view can be only one of the following: |
|
subset_view |
An AuthorizedView permitting access to an explicit subset of a Table. |
FamilySubsets
Subsets of a column family that are included in this AuthorizedView.
| Fields | |
|---|---|
qualifiers[] |
Individual exact column qualifiers to be included in the AuthorizedView. |
qualifier_prefixes[] |
Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). |
ResponseView
Defines a subset of an AuthorizedView's fields.
| Enums | |
|---|---|
RESPONSE_VIEW_UNSPECIFIED |
Uses the default view for each method as documented in the request. |
NAME_ONLY |
Only populates name. |
BASIC |
Only populates the AuthorizedView's basic metadata. This includes: name, deletion_protection, etag. |
FULL |
Populates every fields. |
SubsetView
Defines a simple AuthorizedView that is a subset of the underlying Table.
| Fields | |
|---|---|
row_prefixes[] |
Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). |
family_subsets |
Map from column family name to the columns in this family to be included in the AuthorizedView. |
AutoscalingLimits
Limits for the number of nodes a Cluster can autoscale up/down to.
| Fields | |
|---|---|
min_serve_nodes |
Required. Minimum number of nodes to scale down to. |
max_serve_nodes |
Required. Maximum number of nodes to scale up to. |
AutoscalingTargets
The Autoscaling targets for a Cluster. These determine the recommended nodes.
| Fields | |
|---|---|
cpu_utilization_percent |
The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error. |
storage_utilization_gib_per_node |
The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD. |
Backup
A backup of a Cloud Bigtable table.
| Fields | |
|---|---|
name |
A globally unique identifier for the backup which cannot be changed. Values are of the form The backup is stored in the cluster identified by the prefix of the backup name of the form |
source_table |
Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form |
source_backup |
Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/ |
expire_time |
Required. The expiration time of the backup. When creating a backup or updating its Once the |
start_time |
Output only. |
end_time |
Output only. |
size_bytes |
Output only. Size of the backup in bytes. |
state |
Output only. The current state of the backup. |
encryption_info |
Output only. The encryption information for the backup. |
State
Indicates the current state of the backup.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Not specified. |
CREATING |
The pending backup is still being created. Operations on the backup may fail with FAILED_PRECONDITION in this state. |
READY |
The backup is complete and ready for use. |
BackupInfo
Information about a backup.
| Fields | |
|---|---|
backup |
Output only. Name of the backup. |
start_time |
Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp. |
end_time |
Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp. |
source_table |
Output only. Name of the table the backup was created from. |
source_backup |
Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/ |
ChangeStreamConfig
Change stream configuration.
| Fields | |
|---|---|
retention_period |
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 |
Required. The unique name of the Table for which to check replication consistency. Values are of the form Authorization requires the following IAM permission on the specified resource
|
consistency_token |
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 |
data_boost_read_local_writes |
Checks that reads using an app profile with |
CheckConsistencyResponse
Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
| Fields | |
|---|---|
consistent |
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 |
The unique name of the cluster. Values are of the form |
location |
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 |
state |
Output only. The current state of the cluster. |
serve_nodes |
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. |
default_storage_type |
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. |
encryption_config |
Immutable. The encryption configuration for CMEK-protected clusters. |
Union field
|
|
cluster_config |
Configuration for this cluster. |
ClusterAutoscalingConfig
Autoscaling config for a cluster.
| Fields | |
|---|---|
autoscaling_limits |
Required. Autoscaling limits for this cluster. |
autoscaling_targets |
Required. Autoscaling targets for this cluster. |
ClusterConfig
Configuration for a cluster.
| Fields | |
|---|---|
cluster_autoscaling_config |
Autoscaling configuration for this cluster. |
EncryptionConfig
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
| Fields | |
|---|---|
kms_key_name |
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 |
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 | |
|---|---|
gc_rule |
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 |
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 |
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
If |
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 |
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:
would report (1 + 2 + 0)/3 = 1.5 in this field. |
average_cells_per_column |
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:
would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. |
logical_data_bytes |
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 |
The name of the backup being created through the copy operation. Values are of the form |
source_backup_info |
Information about the source backup that is being copied from. |
progress |
The progress of the |
CopyBackupRequest
The request for CopyBackup.
| Fields | |
|---|---|
parent |
Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: Authorization requires the following IAM permission on the specified resource
|
backup_id |
Required. The id of the new backup. The |
source_backup |
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: Authorization requires the following IAM permission on the specified resource
|
expire_time |
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 |
CreateAppProfileRequest
Request message for BigtableInstanceAdmin.CreateAppProfile.
| Fields | |
|---|---|
parent |
Required. The unique name of the instance in which to create the new app profile. Values are of the form Authorization requires the following IAM permission on the specified resource
|
app_profile_id |
Required. The ID to be used when referring to the new app profile within its instance, e.g., just |
app_profile |
Required. The app profile to be created. Fields marked |
ignore_warnings |
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 |
Required. This is the name of the table the AuthorizedView belongs to. Values are of the form Authorization requires the following IAM permission on the specified resource
|
authorized_view_id |
Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The |
authorized_view |
Required. The AuthorizedView to create. |
CreateBackupMetadata
Metadata type for the operation returned by CreateBackup.
| Fields | |
|---|---|
name |
The name of the backup being created. |
source_table |
The name of the table the backup is created from. |
start_time |
The time at which this operation started. |
end_time |
If set, the time at which this operation finished or was cancelled. |
CreateBackupRequest
The request for CreateBackup.
| Fields | |
|---|---|
parent |
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 Authorization requires one or more of the following IAM permissions on the specified resource
|
backup_id |
Required. The id of the backup to be created. The |
backup |
Required. The backup to create. |
CreateClusterMetadata
The metadata for the Operation returned by CreateCluster.
| Fields | |
|---|---|
original_request |
The request that prompted the initiation of this CreateCluster 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. |
tables |
Keys: the full 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 |
Estimate of the size of the table to be copied. |
estimated_copied_bytes |
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
| 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 |
Required. The unique name of the instance in which to create the new cluster. Values are of the form Authorization requires the following IAM permission on the specified resource
|
cluster_id |
Required. The ID to be used when referring to the new cluster within its instance, e.g., just |
cluster |
Required. The cluster to be created. Fields marked |
CreateInstanceMetadata
The metadata for the Operation returned by CreateInstance.
| Fields | |
|---|---|
original_request |
The request that prompted the initiation of this CreateInstance 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. |
CreateInstanceRequest
Request message for BigtableInstanceAdmin.CreateInstance.
| Fields | |
|---|---|
parent |
Required. The unique name of the project in which to create the new instance. Values are of the form Authorization requires the following IAM permission on the specified resource
|
instance_id |
Required. The ID to be used when referring to the new instance within its project, e.g., just |
instance |
Required. The instance to create. Fields marked |
clusters |
Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just |
CreateTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
| Fields | |
|---|---|
parent |
Required. The unique name of the instance in which to create the table. Values are of the form Authorization requires the following IAM permission on the specified resource
|
table_id |
Required. The name by which the new table should be referred to within the parent instance, e.g., |
table |
Required. The Table to create. |
initial_splits[] |
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, Example:
|
Split
An initial split point for a newly created table.
| Fields | |
|---|---|
key |
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 |
Required. The unique name of the app profile to be deleted. Values are of the form Authorization requires the following IAM permission on the specified resource
|
ignore_warnings |
Required. If true, ignore safety checks when deleting the app profile. |
DeleteAuthorizedViewRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView
| Fields | |
|---|---|
name |
Required. The unique name of the AuthorizedView to be deleted. Values are of the form Authorization requires the following IAM permission on the specified resource
|
etag |
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 |
Required. Name of the backup to delete. Values are of the form Authorization requires the following IAM permission on the specified resource
|
DeleteClusterRequest
Request message for BigtableInstanceAdmin.DeleteCluster.
| Fields | |
|---|---|
name |
Required. The unique name of the cluster to be deleted. Values are of the form Authorization requires the following IAM permission on the specified resource
|
DeleteInstanceRequest
Request message for BigtableInstanceAdmin.DeleteInstance.
| Fields | |
|---|---|
name |
Required. The unique name of the instance to be deleted. Values are of the form Authorization requires the following IAM permission on the specified resource
|
DeleteTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable
| Fields | |
|---|---|
name |
Required. The unique name of the table to be deleted. Values are of the form Authorization requires the following IAM permission on the specified resource
|
DropRowRangeRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
| Fields | |
|---|---|
name |
Required. The unique name of the table on which to drop a range of rows. Values are of the form Authorization requires the following IAM permission on the specified resource
|
Union field target. Delete all rows or by prefix. target can be only one of the following: |
|
row_key_prefix |
Delete all rows that start with this row key prefix. Prefix cannot be zero length. |
delete_all_data_from_table |
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 | |
|---|---|
encryption_type |
Output only. The type of encryption used to protect this resource. |
encryption_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 |
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 |
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 |
Delete cells that would be deleted by every nested rule. |
union |
Delete cells that would be deleted by any nested rule. |
Intersection
A GcRule which deletes cells matching all of the given rules.
| Fields | |
|---|---|
rules[] |
Only delete cells which would be deleted by every element of |
Union
A GcRule which deletes cells matching any of the given rules.
| Fields | |
|---|---|
rules[] |
Delete cells which would be deleted by any element of |
GenerateConsistencyTokenRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
| Fields | |
|---|---|
name |
Required. The unique name of the Table for which to create a consistency token. Values are of the form Authorization requires the following IAM permission on the specified resource
|
GenerateConsistencyTokenResponse
Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
| Fields | |
|---|---|
consistency_token |
The generated consistency token. |
GetAppProfileRequest
Request message for BigtableInstanceAdmin.GetAppProfile.
| Fields | |
|---|---|
name |
Required. The unique name of the requested app profile. Values are of the form Authorization requires the following IAM permission on the specified resource
|
GetAuthorizedViewRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView
| Fields | |
|---|---|
name |
Required. The unique name of the requested AuthorizedView. Values are of the form Authorization requires the following IAM permission on the specified resource
|
view |
Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC. |
GetBackupRequest
The request for GetBackup.
| Fields | |
|---|---|
name |
Required. Name of the backup. Values are of the form Authorization requires the following IAM permission on the specified resource
|
GetClusterRequest
Request message for BigtableInstanceAdmin.GetCluster.
| Fields | |
|---|---|
name |
Required. The unique name of the requested cluster. Values are of the form Authorization requires the following IAM permission on the specified resource
|
GetInstanceRequest
Request message for BigtableInstanceAdmin.GetInstance.
| Fields | |
|---|---|
name |
Required. The unique name of the requested instance. Values are of the form Authorization requires the following IAM permission on the specified resource
|
GetTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetTable
| Fields | |
|---|---|
name |
Required. The unique name of the requested table. Values are of the form Authorization requires the following IAM permission on the specified resource
|
view |
The view to be applied to the returned table's fields. Defaults to |
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 |
The unique name of the hot tablet. Values are of the form |
table_name |
Name of the table that contains the tablet. Values are of the form |
start_time |
Output only. The start time of the hot tablet. |
end_time |
Output only. The end time of the hot tablet. |
start_key |
Tablet Start Key (inclusive). |
end_key |
Tablet End Key (inclusive). |
node_cpu_usage_percent |
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 |
The unique name of the instance. Values are of the form |
display_name |
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 |
Output only. The current state of the instance. |
type |
The type of the instance. Defaults to |
labels |
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.
|
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 |
satisfies_pzs |
Output only. Reserved for future use. |
satisfies_pzi |
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 |
Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form Authorization requires the following IAM permission on the specified resource
|
page_size |
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 |
The value of |
ListAppProfilesResponse
Response message for BigtableInstanceAdmin.ListAppProfiles.
| Fields | |
|---|---|
app_profiles[] |
The list of requested app profiles. |
next_page_token |
Set if not all app profiles could be returned in a single response. Pass this value to |
failed_locations[] |
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 |
ListAuthorizedViewsRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews
| Fields | |
|---|---|
parent |
Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form Authorization requires the following IAM permission on the specified resource
|
page_size |
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 |
Optional. The value of |
view |
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 | |
|---|---|
authorized_views[] |
The AuthorizedViews present in the requested table. |
next_page_token |
Set if not all tables could be returned in a single response. Pass this value to |
ListBackupsRequest
The request for ListBackups.
| Fields | |
|---|---|
parent |
Required. The cluster to list backups from. Values are of the form Authorization requires the following IAM permission on the specified resource
|
filter |
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:
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:
|
order_by |
An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Fields supported are:
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 |
page_size |
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
page_token |
If non-empty, |
ListBackupsResponse
The response for ListBackups.
| Fields | |
|---|---|
backups[] |
The list of matching backups. |
next_page_token |
|
ListClustersRequest
Request message for BigtableInstanceAdmin.ListClusters.
| Fields | |
|---|---|
parent |
Required. The unique name of the instance for which a list of clusters is requested. Values are of the form Authorization requires the following IAM permission on the specified resource
|
page_token |
DEPRECATED: This field is unused and ignored. |
ListClustersResponse
Response message for BigtableInstanceAdmin.ListClusters.
| Fields | |
|---|---|
clusters[] |
The list of requested clusters. |
failed_locations[] |
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 |
next_page_token |
DEPRECATED: This field is unused and ignored. |
ListHotTabletsRequest
Request message for BigtableInstanceAdmin.ListHotTablets.
| Fields | |
|---|---|
parent |
Required. The cluster name to list hot tablets. Value is in the following form: Authorization requires the following IAM permission on the specified resource
|
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 |
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 |
The value of |
ListHotTabletsResponse
Response message for BigtableInstanceAdmin.ListHotTablets.
| Fields | |
|---|---|
hot_tablets[] |
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 |
Set if not all hot tablets could be returned in a single response. Pass this value to |
ListInstancesRequest
Request message for BigtableInstanceAdmin.ListInstances.
| Fields | |
|---|---|
parent |
Required. The unique name of the project for which a list of instances is requested. Values are of the form Authorization requires the following IAM permission on the specified resource
|
page_token |
DEPRECATED: This field is unused and ignored. |
ListInstancesResponse
Response message for BigtableInstanceAdmin.ListInstances.
| Fields | |
|---|---|
instances[] |
The list of requested instances. |
failed_locations[] |
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 |
next_page_token |
DEPRECATED: This field is unused and ignored. |
ListTablesRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
| Fields | |
|---|---|
parent |
Required. The unique name of the instance for which tables should be listed. Values are of the form Authorization requires the following IAM permission on the specified resource
|
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 |
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 |
The value of |
ListTablesResponse
Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
| Fields | |
|---|---|
tables[] |
The tables present in the requested instance. |
next_page_token |
Set if not all tables could be returned in a single response. Pass this value to |
ModifyColumnFamiliesRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
| Fields | |
|---|---|
name |
Required. The unique name of the table whose families should be modified. Values are of the form Authorization requires the following IAM permission on the specified resource
|
modifications[] |
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 |
Optional. If true, ignore safety checks when modifying the column families. |
Modification
A create, update, or delete of a particular column family.
| Fields | |
|---|---|
id |
The ID of the column family to be modified. |
update_mask |
Optional. A mask specifying which fields (e.g. |
Union field mod. Column family modifications. mod can be only one of the following: |
|
create |
Create a new column family with the specified schema, or fail if one already exists with the given ID. |
update |
Update an existing column family to the specified schema, or fail if no column family exists with the given ID. |
drop |
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 |
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 |
Name of the restored table being optimized. |
progress |
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 |
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 |
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 |
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 |
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 |
Name of the table being created and restored to. |
source_type |
The type of the restore source. |
optimize_table_operation_name |
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 [OptimizeRestoreTableMetadata][]. The response type is |
progress |
The progress of the |
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 |
|
RestoreTableRequest
The request for RestoreTable.
| Fields | |
|---|---|
parent |
Required. The name of the instance in which to create the restored table. Values are of the form Authorization requires the following IAM permission on the specified resource
|
table_id |
Required. The id of the table to create and restore to. This table must not already exist. The |
Union field source. Required. The source from which to restore. source can be only one of the following: |
|
backup |
Name of the backup from which to restore. Values are of the form Authorization requires the following IAM permission on the specified resource
|
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 |
The unique name of the table. Values are of the form |
cluster_states |
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 |
column_families |
The column families configured for this table, mapped by column family ID. Views: |
granularity |
Immutable. The granularity (i.e. |
restore_info |
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 |
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. |
deletion_protection |
Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:
Note one can still delete the data stored in the table through Data APIs. |
stats |
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. |
Union field
|
|
automated_backup_policy |
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. The only supported value at this time is 3 days. |
frequency |
Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. |
ClusterState
The state of a table's data in a particular cluster.
| Fields | |
|---|---|
replication_state |
Output only. The state of replication for the table in this cluster. |
encryption_info[] |
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 |
How many rows are in the table. |
average_columns_per_row |
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:
would report (2 + 3)/2 = 2.5 in this field. |
average_cells_per_column |
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:
would report (4 + 15)/(2 + 3) = 3.8 in this field. |
logical_data_bytes |
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/from the underlying data.
Each encoding also defines the following properties:
- Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, not the decoded type.
- Example: BYTES values sort in the same order as their raw encodings.
- Counterexample: Encoding INT64 as a fixed-width decimal string does not preserve sort order when dealing with negative numbers.
INT64(1) > INT64(-1), butSTRING("-00001") > STRING("00001).
- Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins?
- Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign.
- Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends.
- Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?
| Fields | |
|---|---|
Union field kind. The kind of type that this represents. kind can be only one of the following: |
|
bytes_type |
Bytes |
string_type |
String |
int64_type |
Int64 |
float32_type |
Float32 |
float64_type |
Float64 |
bool_type |
Bool |
timestamp_type |
Timestamp |
date_type |
Date |
aggregate_type |
Aggregate |
struct_type |
Struct |
array_type |
Array |
map_type |
Map |
Aggregate
A value that combines incremental updates into a summarized value.
Data is never directly written or read using type Aggregate. Writes will provide either the input_type or state_type, and reads will always return the state_type .
| Fields | |
|---|---|
input_type |
Type of the inputs that are accumulated by this |
state_type |
Output only. Type that holds the internal accumulator state for the |
Union field aggregator. Which aggregator function to use. The configured types must match. aggregator can be only one of the following: |
|
sum |
Sum aggregator. |
hllpp_unique_count |
HyperLogLogPlusPlusUniqueCount aggregator. |
max |
Max aggregator. |
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 |
The type of the elements in the array. This must not be |
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/from lower level types. |
Encoding
Rules used to convert to/from lower level types.
| Fields | |
|---|---|
Union field encoding. Which encoding to use. encoding can be only one of the following: |
|
raw |
Use |
Raw
This type has no fields.
Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A
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/from lower level types. |
Encoding
Rules used to convert to/from lower level types.
| Fields | |
|---|---|
Union field encoding. Which encoding to use. encoding can be only one of the following: |
|
big_endian_bytes |
Use |
BigEndianBytes
Encodes the value as an 8-byte big endian twos complement Bytes value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation BINARY encoding - HBase Bytes.toBytes - Java ByteBuffer.putLong() with ByteOrder.BIG_ENDIAN
| Fields | |
|---|---|
bytes_type |
Deprecated: ignored if set. |
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 |
The type of a map key. Only |
value_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/from lower level types. |
Encoding
Rules used to convert to/from lower level types.
| Fields | |
|---|---|
Union field encoding. Which encoding to use. encoding can be only one of the following: |
|
utf8_raw |
Deprecated: if set, converts to an empty |
utf8_bytes |
Use |
Utf8Bytes
This type has no fields.
UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation TEXT encoding - HBase Bytes.toBytes - Java String#getBytes(StandardCharsets.UTF_8)
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[] |
The names and types of the fields in this struct. |
Field
A struct field and its type.
| Fields | |
|---|---|
field_name |
The field name (optional). Fields without a |
type |
The type of values in this field. |
Timestamp
This type has no fields.
Timestamp Values of type Timestamp are stored in Value.timestamp_value.
UndeleteTableMetadata
Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.
| Fields | |
|---|---|
name |
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 |
Required. The unique name of the table to be restored. Values are of the form Authorization requires the following IAM permission on the specified resource
|
UpdateAppProfileMetadata
This type has no fields.
The metadata for the Operation returned by UpdateAppProfile.
UpdateAppProfileRequest
Request message for BigtableInstanceAdmin.UpdateAppProfile.
| Fields | |
|---|---|
app_profile |
Required. The app profile which will (partially) replace the current value. |
update_mask |
Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced. |
ignore_warnings |
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 |
Required. The AuthorizedView to update. The Authorization requires the following IAM permission on the specified resource
|
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 |
ignore_warnings |
Optional. If true, ignore the safety checks when updating the AuthorizedView. |
UpdateBackupRequest
The request for UpdateBackup.
| Fields | |
|---|---|
backup |
Required. The backup to update.
Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. A mask specifying which fields (e.g. |
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 |
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 |
The time at which the operation failed or was completed successfully. |
UpdateTableMetadata
Metadata type for the operation returned by UpdateTable.
| Fields | |
|---|---|
name |
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 |
Required. The table to update. The table's Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. The list of fields to update. A mask specifying which fields (e.g.
If |