Module model 

The messages and enums that are part of this client library.

Modules

app_profile

Defines additional types related to AppProfile.

authorized_view

Defines additional types related to AuthorizedView.

backup

Defines additional types related to Backup.

check_consistency_request

Defines additional types related to CheckConsistencyRequest.

cluster

Defines additional types related to Cluster.

create_cluster_metadata

Defines additional types related to CreateClusterMetadata.

create_table_request

Defines additional types related to CreateTableRequest.

drop_row_range_request

Defines additional types related to DropRowRangeRequest.

encryption_info

Defines additional types related to EncryptionInfo.

gc_rule

Defines additional types related to GcRule.

instance

Defines additional types related to Instance.

modify_column_families_request

Defines additional types related to ModifyColumnFamiliesRequest.

restore_info

Defines additional types related to RestoreInfo.

restore_table_metadata

Defines additional types related to RestoreTableMetadata.

restore_table_request

Defines additional types related to RestoreTableRequest.

schema_bundle

Defines additional types related to SchemaBundle.

snapshot

Defines additional types related to Snapshot.

table

Defines additional types related to Table.

type

Defines additional types related to Type.

Structs

AppProfile

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

AuthorizedView

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.

AutoscalingLimits

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

AutoscalingTargets

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

Backup

A backup of a Cloud Bigtable table.

BackupInfo

Information about a backup.

ChangeStreamConfig

Change stream configuration.

CheckConsistencyRequest

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

CheckConsistencyResponse

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

Cluster

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

ColumnFamily

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

CopyBackupMetadata

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

CopyBackupRequest

The request for CopyBackup.

CreateAppProfileRequest

Request message for BigtableInstanceAdmin.CreateAppProfile.

CreateAuthorizedViewMetadata

The metadata for the Operation returned by CreateAuthorizedView.

CreateAuthorizedViewRequest

The request for CreateAuthorizedView

CreateBackupMetadata

Metadata type for the operation returned by CreateBackup.

CreateBackupRequest

The request for CreateBackup.

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

CreateLogicalViewMetadata

The metadata for the Operation returned by CreateLogicalView.

CreateLogicalViewRequest

Request message for BigtableInstanceAdmin.CreateLogicalView.

CreateMaterializedViewMetadata

The metadata for the Operation returned by CreateMaterializedView.

CreateMaterializedViewRequest

Request message for BigtableInstanceAdmin.CreateMaterializedView.

CreateSchemaBundleMetadata

The metadata for the Operation returned by CreateSchemaBundle.

CreateSchemaBundleRequest

The request for CreateSchemaBundle.

CreateTableFromSnapshotMetadata

The metadata for the Operation returned by CreateTableFromSnapshot.

CreateTableFromSnapshotRequest

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

CreateTableRequest

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

DataBoostReadLocalWrites

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

DeleteAppProfileRequest

Request message for BigtableInstanceAdmin.DeleteAppProfile.

DeleteAuthorizedViewRequest

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

DeleteBackupRequest

The request for DeleteBackup.

DeleteClusterRequest

Request message for BigtableInstanceAdmin.DeleteCluster.

DeleteInstanceRequest

Request message for BigtableInstanceAdmin.DeleteInstance.

DeleteLogicalViewRequest

Request message for BigtableInstanceAdmin.DeleteLogicalView.

DeleteMaterializedViewRequest

Request message for BigtableInstanceAdmin.DeleteMaterializedView.

DeleteSchemaBundleRequest

The request for DeleteSchemaBundle.

DeleteSnapshotRequest

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

DeleteTableRequest

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

DropRowRangeRequest

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

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.

GcRule

Rule for determining which cells to delete during garbage collection.

GenerateConsistencyTokenRequest

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

GenerateConsistencyTokenResponse

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

GetAppProfileRequest

Request message for BigtableInstanceAdmin.GetAppProfile.

GetAuthorizedViewRequest

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

GetBackupRequest

The request for GetBackup.

GetClusterRequest

Request message for BigtableInstanceAdmin.GetCluster.

GetInstanceRequest

Request message for BigtableInstanceAdmin.GetInstance.

GetLogicalViewRequest

Request message for BigtableInstanceAdmin.GetLogicalView.

GetMaterializedViewRequest

Request message for BigtableInstanceAdmin.GetMaterializedView.

GetSchemaBundleRequest

The request for GetSchemaBundle.

GetSnapshotRequest

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

GetTableRequest

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

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.

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.

ListAppProfilesRequest

Request message for BigtableInstanceAdmin.ListAppProfiles.

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

ListAuthorizedViewsRequest

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

ListAuthorizedViewsResponse

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

ListBackupsRequest

The request for ListBackups.

ListBackupsResponse

The response for ListBackups.

ListClustersRequest

Request message for BigtableInstanceAdmin.ListClusters.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

ListHotTabletsRequest

Request message for BigtableInstanceAdmin.ListHotTablets.

ListHotTabletsResponse

Response message for BigtableInstanceAdmin.ListHotTablets.

ListInstancesRequest

Request message for BigtableInstanceAdmin.ListInstances.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

ListLogicalViewsRequest

Request message for BigtableInstanceAdmin.ListLogicalViews.

ListLogicalViewsResponse

Response message for BigtableInstanceAdmin.ListLogicalViews.

ListMaterializedViewsRequest

Request message for BigtableInstanceAdmin.ListMaterializedViews.

ListMaterializedViewsResponse

Response message for BigtableInstanceAdmin.ListMaterializedViews.

ListSchemaBundlesRequest

The request for ListSchemaBundles.

ListSchemaBundlesResponse

The response for ListSchemaBundles.

ListSnapshotsRequest

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

ListSnapshotsResponse

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

ListTablesRequest

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

ListTablesResponse

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

LogicalView

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

MaterializedView

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

ModifyColumnFamiliesRequest

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

OperationProgress

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

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.

PartialUpdateClusterMetadata

The metadata for the Operation returned by PartialUpdateCluster.

PartialUpdateClusterRequest

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

ProtoSchema

Represents a protobuf schema.

RestoreInfo

Information about a table restore.

RestoreTableMetadata

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

RestoreTableRequest

The request for RestoreTable.

SchemaBundle

A named collection of related schemas.

Snapshot

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.

SnapshotTableMetadata

The metadata for the Operation returned by SnapshotTable.

SnapshotTableRequest

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

StandardReadRemoteWrites

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

Table

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

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.

UndeleteTableMetadata

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

UndeleteTableRequest

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

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

UpdateAppProfileRequest

Request message for BigtableInstanceAdmin.UpdateAppProfile.

UpdateAuthorizedViewMetadata

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

UpdateAuthorizedViewRequest

The request for UpdateAuthorizedView.

UpdateBackupRequest

The request for UpdateBackup.

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

UpdateLogicalViewMetadata

The metadata for the Operation returned by UpdateLogicalView.

UpdateLogicalViewRequest

Request message for BigtableInstanceAdmin.UpdateLogicalView.

UpdateMaterializedViewMetadata

The metadata for the Operation returned by UpdateMaterializedView.

UpdateMaterializedViewRequest

Request message for BigtableInstanceAdmin.UpdateMaterializedView.

UpdateSchemaBundleMetadata

The metadata for the Operation returned by UpdateSchemaBundle.

UpdateSchemaBundleRequest

The request for UpdateSchemaBundle.

UpdateTableMetadata

Metadata type for the operation returned by UpdateTable.

UpdateTableRequest

The request for UpdateTable.

Enums

RestoreSourceType

Indicates the type of the restore source.

StorageType

Storage media types for persisting Bigtable data.