Google Cloud Bigtable Administration v2 API - Namespace Google.Cloud.Bigtable.Admin.V2 (3.17.0)

A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

Container for nested types declared in the AppProfile message type.

Data Boost is a serverless compute capability that lets you run high-throughput read jobs on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Currently, Data Boost exclusively supports read-only use-cases with single-cluster routing.

Data Boost reads are only guaranteed to see the results of writes that were written at least 30 minutes ago. This means newly written values may not become visible for up to 30m, and also means that old values may remain visible for up to 30m after being deleted or overwritten. To mitigate the staleness of the data, users may either wait 30m, or use CheckConsistency.

Container for nested types declared in the DataBoostIsolationReadOnly message type.

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.

Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.

Standard options for isolating this app profile's traffic from other use cases.

Resource name for the AppProfile resource.

AuthorizedViews represent subsets of a particular Cloud Bigtable table. Users can configure access to each Authorized View independently from the table and use the existing Data APIs to access the subset of data.

Container for nested types declared in the AuthorizedView message type.

Subsets of a column family that are included in this AuthorizedView.

Defines a simple AuthorizedView that is a subset of the underlying Table.

Resource name for the AuthorizedView resource.

Limits for the number of nodes a Cluster can autoscale up/down to.

The Autoscaling targets for a Cluster. These determine the recommended nodes.

A backup of a Cloud Bigtable table.

Container for nested types declared in the Backup message type.

Information about a backup.

Resource name for the Backup resource.

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.

Base class for server-side implementations of BigtableInstanceAdmin

Client for BigtableInstanceAdmin

BigtableInstanceAdmin client wrapper, for convenient use.

Builder class for BigtableInstanceAdminClient to provide simple configuration of credentials, endpoint etc.

BigtableInstanceAdmin client wrapper implementation, for convenient use.

Settings for BigtableInstanceAdminClient instances.

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

Base class for server-side implementations of BigtableTableAdmin

Client for BigtableTableAdmin

BigtableTableAdmin client wrapper, for convenient use.

Builder class for BigtableTableAdminClient to provide simple configuration of credentials, endpoint etc.

BigtableTableAdmin client wrapper implementation, for convenient use.

Settings for BigtableTableAdminClient instances.

Change stream configuration.

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

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

A resizable group of nodes in a particular cloud location, capable of serving all [Tables][google.bigtable.admin.v2.Table] in the parent [Instance][google.bigtable.admin.v2.Instance].

Container for nested types declared in the Cluster message type.

Autoscaling config for a cluster.

Configuration for a cluster.

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

Resource name for the Cluster resource.

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

Metadata type for the google.longrunning.Operation returned by [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].

The request for [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].

Request message for BigtableInstanceAdmin.CreateAppProfile.

The metadata for the Operation returned by CreateAuthorizedView.

The request for [CreateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView]

Metadata type for the operation returned by [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

The request for [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

The metadata for the Operation returned by CreateCluster.

Container for nested types declared in the CreateClusterMetadata message type.

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

Container for nested types declared in the TableProgress message type.

Request message for BigtableInstanceAdmin.CreateCluster.

The metadata for the Operation returned by CreateInstance.

Request message for BigtableInstanceAdmin.CreateInstance.

The metadata for the Operation returned by CreateTableFromSnapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

Container for nested types declared in the CreateTableRequest message type.

An initial split point for a newly created table.

Resource name for the CryptoKey resource.

Resource name for the CryptoKeyVersion resource.

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

Request message for BigtableInstanceAdmin.DeleteAppProfile.

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

The request for [DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup].

Request message for BigtableInstanceAdmin.DeleteCluster.

Request message for BigtableInstanceAdmin.DeleteInstance.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

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

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.

Container for nested types declared in the EncryptionInfo message type.

Rule for determining which cells to delete during garbage collection.

Container for nested types declared in the GcRule message type.

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

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

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

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

Request message for BigtableInstanceAdmin.GetAppProfile.

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

The request for [GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.GetBackup].

Request message for BigtableInstanceAdmin.GetCluster.

Request message for BigtableInstanceAdmin.GetInstance.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

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.

Resource name for the HotTablet resource.

A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them. All tables in an instance are served from all [Clusters][google.bigtable.admin.v2.Cluster] in the instance.

Container for nested types declared in the Instance message type.

Request message for BigtableInstanceAdmin.ListAppProfiles.

Response message for BigtableInstanceAdmin.ListAppProfiles.

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

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

The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

The response for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

Request message for BigtableInstanceAdmin.ListClusters.

Response message for BigtableInstanceAdmin.ListClusters.

Request message for BigtableInstanceAdmin.ListHotTablets.

Response message for BigtableInstanceAdmin.ListHotTablets.

Request message for BigtableInstanceAdmin.ListInstances.

Response message for BigtableInstanceAdmin.ListInstances.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

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

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

Container for nested types declared in the ModifyColumnFamiliesRequest message type.

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

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

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.

The metadata for the Operation returned by PartialUpdateCluster.

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

Information about a table restore.

Metadata type for the long-running operation returned by [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

The request for [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Container for nested types declared in the Snapshot message type.

Resource name for the Snapshot resource.

The metadata for the Operation returned by SnapshotTable.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

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

Container for nested types declared in the Table message type.

Defines an automated backup policy for a table

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

Container for nested types declared in the ClusterState message 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. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like CAST.

Each link in the encoding chain also defines the following properties:

• Natural sort: 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 to a fixed-width STRING does not preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001).
  • The overall encoding chain has this property if every link does.
• 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.
  • The overall encoding chain has this property if any link does.
• Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?

Container for nested types declared in the Type message type.

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 .

Container for nested types declared in the Aggregate message type.

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

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

Container for nested types declared in the Bytes message type.

Rules used to convert to/from lower level types.

Container for nested types declared in the Encoding message type.

Leaves the value "as-is"

• Natural sort? Yes
• Self-delimiting? No
• Compatibility? N/A

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

Container for nested types declared in the Int64 message type.

Rules used to convert to/from lower level types.

Container for nested types declared in the Encoding message type.

Encodes the value as an 8-byte big endian twos complement Bytes value.

• Natural sort? No (positive values only)
• Self-delimiting? Yes
• Compatibility?
  • BigQuery Federation BINARY encoding
  • HBase Bytes.toBytes
  • Java ByteBuffer.putLong() with ByteOrder.BIG_ENDIAN

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

Container for nested types declared in the String message type.

Rules used to convert to/from lower level types.

Container for nested types declared in the Encoding message type.

UTF-8 encoding

• Natural sort? No (ASCII characters only)
• Self-delimiting? No
• Compatibility?
  • BigQuery Federation TEXT encoding
  • HBase Bytes.toBytes
  • Java String#getBytes(StandardCharsets.UTF_8)

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

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

The metadata for the Operation returned by UpdateAppProfile.

Request message for BigtableInstanceAdmin.UpdateAppProfile.

Metadata for the google.longrunning.Operation returned by [UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].

The request for [UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].

The request for [UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup].

The metadata for the Operation returned by UpdateCluster.

The metadata for the Operation returned by UpdateInstance.

Metadata type for the operation returned by [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].

The request for [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].

Enum of possible cases for the "isolation" oneof.

Enum of possible cases for the "routing_policy" oneof.

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.

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.

The possible contents of AppProfileName.

Enum of possible cases for the "authorized_view" oneof.

Defines a subset of an AuthorizedView's fields.

The possible contents of AuthorizedViewName.

Indicates the current state of the backup.

The possible contents of BackupName.

Enum of possible cases for the "mode" oneof.

Enum of possible cases for the "config" oneof.

Possible states of a cluster.

The possible contents of ClusterName.

The possible contents of CryptoKeyName.

The possible contents of CryptoKeyVersionName.

Enum of possible cases for the "target" oneof.

Possible encryption types for a resource.

Enum of possible cases for the "rule" oneof.

The possible contents of HotTabletName.

Possible states of an instance.

The type of the instance.

Enum of possible cases for the "mod" oneof.

Enum of possible cases for the "source_info" oneof.

Indicates the type of the restore source.

Enum of possible cases for the "source_info" oneof.

Enum of possible cases for the "source" oneof.

Possible states of a snapshot.

The possible contents of SnapshotName.

Storage media types for persisting Bigtable data.

Enum of possible cases for the "automated_backup_config" oneof.

Table replication states.

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

Defines a view over a table's fields.

Enum of possible cases for the "kind" oneof.

Enum of possible cases for the "aggregator" oneof.

Enum of possible cases for the "encoding" oneof.

Enum of possible cases for the "encoding" oneof.

Enum of possible cases for the "encoding" oneof.