API documentation for types package.
Classes
AppProfile
A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CheckConsistencyResponse
Response message for
google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
Cluster
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].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ColumnFamily
A set of columns within a table which share a common configuration.
CopyBackupMetadata
Metadata type for the google.longrunning.Operation returned by
CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
CopyBackupRequest
The request for
CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
CreateAppProfileRequest
Request message for BigtableInstanceAdmin.CreateAppProfile.
CreateAuthorizedViewMetadata
The metadata for the Operation returned by CreateAuthorizedView.
CreateAuthorizedViewRequest
The request for
CreateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView]
CreateBackupMetadata
Metadata type for the operation returned by
CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].
CreateBackupRequest
The request for
CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.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][google.bigtable.admin.v2.BigtableTableAdmin.CreateSchemaBundle].
CreateSchemaBundleRequest
The request for
CreateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.CreateSchemaBundle].
CreateTableFromSnapshotMetadata
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.
CreateTableFromSnapshotRequest
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.
CreateTableRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][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][google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView]
DeleteBackupRequest
The request for
DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.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][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSchemaBundle].
DeleteSnapshotRequest
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.
DeleteTableRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
DropRowRangeRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GenerateConsistencyTokenRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
GenerateConsistencyTokenResponse
Response message for
google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
GetAppProfileRequest
Request message for BigtableInstanceAdmin.GetAppProfile.
GetAuthorizedViewRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView]
GetBackupRequest
The request for
GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.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][google.bigtable.admin.v2.BigtableTableAdmin.GetSchemaBundle].
GetSnapshotRequest
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.
GetTableRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.GetTable][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][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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListAppProfilesRequest
Request message for BigtableInstanceAdmin.ListAppProfiles.
ListAppProfilesResponse
Response message for BigtableInstanceAdmin.ListAppProfiles.
ListAuthorizedViewsRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
ListAuthorizedViewsResponse
Response message for
google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
ListBackupsRequest
The request for
ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
ListBackupsResponse
The response for
ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.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][google.bigtable.admin.v2.BigtableTableAdmin.ListSchemaBundles].
ListSchemaBundlesResponse
The response for
ListSchemaBundles][google.bigtable.admin.v2.BigtableTableAdmin.ListSchemaBundles].
ListSnapshotsRequest
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.
ListSnapshotsResponse
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.
ListTablesRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
ListTablesResponse
Response message for
google.bigtable.admin.v2.BigtableTableAdmin.ListTables][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][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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RestoreSourceType
Indicates the type of the restore source.
RestoreTableMetadata
Metadata type for the long-running operation returned by
RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RestoreTableRequest
The request for
RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SchemaBundle
A named collection of related schemas.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
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.
SnapshotTableMetadata
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.
SnapshotTableRequest
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.
StandardReadRemoteWrites
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.
Table
A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Type
Type represents the type of data that is written to, read from,
or stored in Bigtable. It is heavily based on the GoogleSQL standard
to help maintain familiarity and consistency across products and
features.
For compatibility with Bigtable's existing untyped APIs, each
Type includes an Encoding which describes how to convert to
or from the underlying data.
Each encoding can operate in one of two modes:
- Sorted: In this mode, Bigtable guarantees that
Encode(X) <= Encode(Y)if and only ifX <= Y. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if
X != YthenEncode(X) != Encode(Y). However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value.
The API clearly documents which mode is used wherever an encoding
can be configured. Each encoding also documents which values are
supported in which modes. For example, when encoding INT64 as a
numeric STRING, negative numbers cannot be encoded in sorted mode.
This is because INT64(1) > INT64(-1), but
STRING("-00001") > STRING("00001").
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UndeleteTableMetadata
Metadata type for the operation returned by
google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable].
UndeleteTableRequest
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][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][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
UpdateAuthorizedViewRequest
The request for
UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
UpdateBackupRequest
The request for
UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.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][google.bigtable.admin.v2.BigtableTableAdmin.UpdateSchemaBundle].
UpdateSchemaBundleRequest
The request for
UpdateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.UpdateSchemaBundle].
UpdateTableMetadata
Metadata type for the operation returned by
UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
UpdateTableRequest
The request for
UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].