Index
BigtableInstanceAdmin(interface)BigtableTableAdmin(interface)AppProfile(message)AppProfile.MultiClusterRoutingUseAny(message)AppProfile.SingleClusterRouting(message)CheckConsistencyRequest(message)CheckConsistencyResponse(message)Cluster(message)Cluster.State(enum)ColumnFamily(message)CreateAppProfileRequest(message)CreateClusterMetadata(message)CreateClusterMetadata.TableProgress(message)CreateClusterMetadata.TableProgress.State(enum)CreateClusterRequest(message)CreateInstanceMetadata(message)CreateInstanceRequest(message)CreateTableRequest(message)CreateTableRequest.Split(message)DeleteAppProfileRequest(message)DeleteClusterRequest(message)DeleteInstanceRequest(message)DeleteTableRequest(message)DropRowRangeRequest(message)GcRule(message)GcRule.Intersection(message)GcRule.Union(message)GenerateConsistencyTokenRequest(message)GenerateConsistencyTokenResponse(message)GetAppProfileRequest(message)GetClusterRequest(message)GetInstanceRequest(message)GetTableRequest(message)Instance(message)Instance.State(enum)Instance.Type(enum)ListAppProfilesRequest(message)ListAppProfilesResponse(message)ListClustersRequest(message)ListClustersResponse(message)ListInstancesRequest(message)ListInstancesResponse(message)ListTablesRequest(message)ListTablesResponse(message)ModifyColumnFamiliesRequest(message)ModifyColumnFamiliesRequest.Modification(message)PartialUpdateInstanceRequest(message)StorageType(enum)Table(message)Table.ClusterState(message)Table.ClusterState.ReplicationState(enum)Table.TimestampGranularity(enum)Table.View(enum)UpdateAppProfileMetadata(message)UpdateAppProfileRequest(message)UpdateClusterMetadata(message)UpdateInstanceMetadata(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.
|
|
| CreateInstance | |
|---|---|
|
Create an instance within a project.
|
|
| 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.
|
|
| ListInstances | |
|---|---|
|
Lists information about instances in a project.
|
|
| 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.
|
|
| 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.
|
|
| 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.
|
|
| 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.
|
|
| 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.
|
|
| GetTable | |
|---|---|
|
Gets metadata information about the specified table.
|
|
| 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.
|
|
AppProfile
A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
| Fields | ||
|---|---|---|
name |
( Authorization requires the following Google IAM permission on the specified resource
|
|
etag |
Strongly validated etag for optimistic concurrency control. Preserve the value returned from |
|
description |
Optional 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. |
|
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.
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 |
CheckConsistencyRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
| Fields | |
|---|---|
name |
The unique name of the Table for which to check replication consistency. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
consistency_token |
The token created using GenerateConsistencyToken for the Table. |
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 |
( |
location |
( |
state |
( |
serve_nodes |
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. |
default_storage_type |
( |
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. |
CreateAppProfileRequest
Request message for BigtableInstanceAdmin.CreateAppProfile.
| Fields | |
|---|---|
parent |
The unique name of the instance in which to create the new app profile. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
app_profile_id |
The ID to be used when referring to the new app profile within its instance, e.g., just |
app_profile |
The app profile to be created. Fields marked |
ignore_warnings |
If true, ignore safety checks when creating the app profile. |
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 |
The unique name of the instance in which to create the new cluster. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
cluster_id |
The ID to be used when referring to the new cluster within its instance, e.g., just |
cluster |
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 |
The unique name of the project in which to create the new instance. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
instance_id |
The ID to be used when referring to the new instance within its project, e.g., just |
instance |
The instance to create. Fields marked |
clusters |
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 |
The unique name of the instance in which to create the table. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
table_id |
The name by which the new table should be referred to within the parent instance, e.g., |
table |
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. |
DeleteAppProfileRequest
Request message for BigtableInstanceAdmin.DeleteAppProfile.
| Fields | |
|---|---|
name |
The unique name of the app profile to be deleted. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
ignore_warnings |
If true, ignore safety checks when deleting the app profile. |
DeleteClusterRequest
Request message for BigtableInstanceAdmin.DeleteCluster.
| Fields | |
|---|---|
name |
The unique name of the cluster to be deleted. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
DeleteInstanceRequest
Request message for BigtableInstanceAdmin.DeleteInstance.
| Fields | |
|---|---|
name |
The unique name of the instance to be deleted. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
DeleteTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable
| Fields | |
|---|---|
name |
The unique name of the table to be deleted. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
DropRowRangeRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
| Fields | ||
|---|---|---|
name |
The unique name of the table on which to drop a range of rows. Values are of the form Authorization requires the following Google 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. |
|
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 |
The unique name of the Table for which to create a consistency token. Values are of the form Authorization requires the following Google 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 |
The unique name of the requested app profile. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
GetClusterRequest
Request message for BigtableInstanceAdmin.GetCluster.
| Fields | |
|---|---|
name |
The unique name of the requested cluster. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
GetInstanceRequest
Request message for BigtableInstanceAdmin.GetInstance.
| Fields | |
|---|---|
name |
The unique name of the requested instance. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
GetTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetTable
| Fields | |
|---|---|
name |
The unique name of the requested table. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
view |
The view to be applied to the returned table's fields. Defaults to |
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 |
( |
display_name |
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 |
( |
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.
|
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 |
The instance is meant for development and testing purposes only; it has no performance or uptime guarantees and is not covered by SLA. After a development instance is created, it can be upgraded by updating the instance to type PRODUCTION. An instance created as a production instance cannot be changed to a development instance. When creating a development instance, serve_nodes on the cluster must not be set. |
ListAppProfilesRequest
Request message for BigtableInstanceAdmin.ListAppProfiles.
| Fields | |
|---|---|
parent |
The unique name of the instance for which a list of app profiles is requested. Values are of the form Authorization requires the following Google 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 |
ListClustersRequest
Request message for BigtableInstanceAdmin.ListClusters.
| Fields | |
|---|---|
parent |
The unique name of the instance for which a list of clusters is requested. Values are of the form Authorization requires the following Google 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. |
ListInstancesRequest
Request message for BigtableInstanceAdmin.ListInstances.
| Fields | |
|---|---|
parent |
The unique name of the project for which a list of instances is requested. Values are of the form Authorization requires the following Google 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 |
The unique name of the instance for which tables should be listed. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
view |
The view to be applied to the returned tables' fields. Defaults to |
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 |
The unique name of the table whose families should be modified. Values are of the form Authorization requires the following Google IAM permission on the specified resource
|
modifications[] |
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). |
Modification
A create, update, or delete of a particular column family.
| Fields | ||
|---|---|---|
id |
The ID of the column family to be modified. |
|
Union field mod. Column familiy 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. |
|
PartialUpdateInstanceRequest
Request message for BigtableInstanceAdmin.PartialUpdateInstance.
| Fields | |
|---|---|
instance |
The Instance which will (partially) replace the current value. |
update_mask |
The subset of Instance fields which should be replaced. Must be explicitly set. |
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 |
Output only. 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 |
( |
granularity |
( |
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. |
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. |
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. |
FULL |
Populates all fields. |
UpdateAppProfileMetadata
The metadata for the Operation returned by UpdateAppProfile.
UpdateAppProfileRequest
Request message for BigtableInstanceAdmin.UpdateAppProfile.
| Fields | |
|---|---|
app_profile |
The app profile which will (partially) replace the current value. |
update_mask |
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. |
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. |
