bigtableadmin/v2 library
Cloud Bigtable Admin API - v2
Administer your Cloud Bigtable tables and instances.
For more information, see cloud.google.com/bigtable/
Create an instance of BigtableAdminApi to access these resources:
Classes
- AppProfile
- A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
- AuditConfig
- Specifies the audit configuration for a service.
- AuthorizedView
- An Authorized View of a Cloud Bigtable Table.
- AutomatedBackupPolicy
- Defines an automated backup policy for a table
- AutoscalingLimits
- Limits for the number of nodes a Cluster can autoscale up/down to.
- AutoscalingTargets
- The Autoscaling targets for a Cluster.
- Backup
- A backup of a Cloud Bigtable table.
- BackupInfo
- Information about a backup.
- BigtableAdminApi
- Administer your Cloud Bigtable tables and instances.
- Binding
-
Associates
members
, or principals, with arole
. - 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.
- ClusterAutoscalingConfig
- Autoscaling config for a cluster.
- ClusterConfig
- Configuration for a cluster.
- ClusterState
- The state of a table's data in a particular cluster.
- ColumnFamily
- A set of columns within a table which share a common configuration.
- ColumnFamilyStats
- Approximate statistics related to a single column family within a table.
- CopyBackupRequest
- The request for CopyBackup.
- CreateInstanceRequest
- Request message for BigtableInstanceAdmin.CreateInstance.
- CreateTableRequest
- Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
- 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.
- DropRowRangeRequest
- Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
- EncryptionConfig
- Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
- EncryptionInfo
- Encryption information for a given resource.
- GcRule
- Rule for determining which cells to delete during garbage collection.
- GenerateConsistencyTokenResponse
- Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
- GetIamPolicyRequest
-
Request message for
GetIamPolicy
method. - GoogleBigtableAdminV2AuthorizedViewFamilySubsets
- Subsets of a column family that are included in this AuthorizedView.
- GoogleBigtableAdminV2AuthorizedViewSubsetView
- Defines a simple AuthorizedView that is a subset of the underlying Table.
- GoogleBigtableAdminV2TypeAggregate
- A value that combines incremental updates into a summarized value.
- GoogleBigtableAdminV2TypeArray
- An ordered list of elements of a given type.
- GoogleBigtableAdminV2TypeBytes
-
Bytes Values of type
Bytes
are stored inValue.bytes_value
. - GoogleBigtableAdminV2TypeBytesEncoding
- Rules used to convert to or from lower level types.
- GoogleBigtableAdminV2TypeBytesEncodingRaw
- Leaves the value as-is.
- GoogleBigtableAdminV2TypeInt64
-
Int64 Values of type
Int64
are stored inValue.int_value
. - GoogleBigtableAdminV2TypeInt64Encoding
- Rules used to convert to or from lower level types.
- GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes
- Encodes the value as an 8-byte big-endian two's complement value.
- GoogleBigtableAdminV2TypeMap
- A mapping of keys to values of a given type.
- GoogleBigtableAdminV2TypeString
-
String Values of type
String
are stored inValue.string_value
. - GoogleBigtableAdminV2TypeStringEncoding
- Rules used to convert to or from lower level types.
- GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes
- UTF-8 encoding.
- GoogleBigtableAdminV2TypeStruct
- A structured data value, consisting of fields which map to dynamically typed values.
- GoogleBigtableAdminV2TypeStructEncoding
- Rules used to convert to or from lower level types.
- GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes
-
Fields are encoded independently and concatenated with a configurable
delimiter
in between. - GoogleBigtableAdminV2TypeStructField
- A struct field and its type.
- GoogleBigtableAdminV2TypeTimestamp
-
Timestamp Values of type
Timestamp
are stored inValue.timestamp_value
. - GoogleBigtableAdminV2TypeTimestampEncoding
- Rules used to convert to or from lower level types.
- 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.
- Instance
- A collection of Bigtable Tables and the resources that serve them.
- Intersection
- A GcRule which deletes cells matching all of the given rules.
- ListAppProfilesResponse
- Response message for BigtableInstanceAdmin.ListAppProfiles.
- ListAuthorizedViewsResponse
- Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews
- ListBackupsResponse
- The response for ListBackups.
- ListClustersResponse
- Response message for BigtableInstanceAdmin.ListClusters.
- ListHotTabletsResponse
- Response message for BigtableInstanceAdmin.ListHotTablets.
- ListInstancesResponse
- Response message for BigtableInstanceAdmin.ListInstances.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListTablesResponse
- Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
- Modification
- A create, update, or delete of a particular column family.
- ModifyColumnFamiliesRequest
- Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
- 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.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- OperationsProjectsOperationsResource
- OperationsProjectsResource
- OperationsResource
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- ProjectsInstancesAppProfilesResource
- ProjectsInstancesClustersBackupsResource
- ProjectsInstancesClustersHotTabletsResource
- ProjectsInstancesClustersResource
- ProjectsInstancesLogicalViewsResource
- ProjectsInstancesMaterializedViewsResource
- ProjectsInstancesResource
- ProjectsInstancesTablesAuthorizedViewsResource
- ProjectsInstancesTablesResource
- ProjectsLocationsResource
- ProjectsResource
- RestoreInfo
- Information about a table restore.
- RestoreTableRequest
- The request for RestoreTable.
- SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - SingleClusterRouting
- Unconditionally routes all read/write requests to a specific cluster.
- Split
- An initial split point for a newly created table.
- StandardIsolation
- Standard options for isolating this app profile's traffic from other use cases.
- Table
- A collection of user data indexed by row, column, and timestamp.
- TableStats
- Approximate statistics related to a table.
- Type
-
Type
represents the type of data that is written to, read from, or stored in Bigtable. - Union
- A GcRule which deletes cells matching any of the given rules.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- DataBoostReadLocalWrites = $Empty
- Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- GenerateConsistencyTokenRequest = $Empty
- Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
- GetPolicyOptions = $GetPolicyOptions00
- Encapsulates settings provided to GetIamPolicy.
- GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount = $Empty
- Computes an approximate unique count over the input values.
- GoogleBigtableAdminV2TypeAggregateMax = $Empty
- Computes the max of the input values.
- GoogleBigtableAdminV2TypeAggregateMin = $Empty
- Computes the min of the input values.
- GoogleBigtableAdminV2TypeAggregateSum = $Empty
- Computes the sum of the input values.
- GoogleBigtableAdminV2TypeBool = $Empty
-
bool Values of type
Bool
are stored inValue.bool_value
. - GoogleBigtableAdminV2TypeDate = $Empty
-
Date Values of type
Date
are stored inValue.date_value
. - GoogleBigtableAdminV2TypeFloat32 = $Empty
-
Float32 Values of type
Float32
are stored inValue.float_value
. - GoogleBigtableAdminV2TypeFloat64 = $Empty
-
Float64 Values of type
Float64
are stored inValue.float_value
. - GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes = $Empty
- Encodes the value in a variable length binary format of up to 10 bytes.
- GoogleBigtableAdminV2TypeStringEncodingUtf8Raw = $Shared01
-
Deprecated: prefer the equivalent
Utf8Bytes
. - GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes = $Empty
- Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between.
- GoogleBigtableAdminV2TypeStructEncodingSingleton = $Empty
-
Uses the encoding of
fields[0].type
as-is. - Location = $Location00
- A resource that represents a Google Cloud location.
- RowAffinity = $Empty
- If enabled, Bigtable will route the request based on the row key of the request, rather than randomly.
- StandardReadRemoteWrites = $Empty
- Checks that all writes before the consistency token was generated are replicated in every cluster and readable.
- Status = $Status00
-
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method. - UndeleteTableRequest = $Empty
- Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.