v2

v2

Source:

Members

(static) ReplicationState :number

Table replication states.

Properties:
Name Type Description
STATE_NOT_KNOWN number

The replication state of the table is unknown in this cluster.
INITIALIZING number

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 number

The table is temporarily unable to serve Data API requests from this cluster due to planned internal maintenance.
UNPLANNED_MAINTENANCE number

The table is temporarily unable to serve Data API requests from this cluster due to unplanned or emergency maintenance.
READY number

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.
Source:

(static) State :number

Possible states of an instance.

Properties:
Name Type Description
STATE_NOT_KNOWN number

The state of the instance could not be determined.
READY number

The instance has been successfully created and can serve requests to its tables.
CREATING number

The instance is currently being created, and may be destroyed if the creation process encounters an error.
Source:

(static) State :number

Possible states of a cluster.

Properties:
Name Type Description
STATE_NOT_KNOWN number

The state of the cluster could not be determined.
READY number

The cluster has been successfully created and is ready to serve requests.
CREATING number

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 number

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 number

The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.
Source:

(static) State :number

Possible states of a snapshot.

Properties:
Name Type Description
STATE_NOT_KNOWN number

The state of the snapshot could not be determined.
READY number

The snapshot has been successfully created and can serve all requests.
CREATING number

The snapshot is currently being created, and may be destroyed if the creation process encounters an error. A snapshot may not be restored to a table while it is being created.
Source:

(static) TimestampGranularity :number

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

Properties:
Name Type Description
TIMESTAMP_GRANULARITY_UNSPECIFIED number

The user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
MILLIS number

The table keeps data versioned at a granularity of 1ms.
Source:

(static) Type :number

The type of the instance.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

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 number

An instance meant for production use. serve_nodes must be set on the cluster.
DEVELOPMENT number

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.
Source:

(static) View :number

Defines a view over a table's fields.

Properties:
Name Type Description
VIEW_UNSPECIFIED number

Uses the default view for each method as documented in its request.
NAME_ONLY number

Only populates name.
SCHEMA_VIEW number

Only populates name and fields related to the table's schema.
REPLICATION_VIEW number

Only populates name and fields related to the table's replication state.
FULL number

Populates all fields.
Source:

Type Definitions

AppProfile

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

Properties:
Name Type Description
name string

(OutputOnly) The unique name of the app profile. Values are of the form projects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.
etag string

Strongly validated etag for optimistic concurrency control. Preserve the value returned from GetAppProfile when calling UpdateAppProfile to fail the request if there has been a modification in the mean time. The update_mask of the request need not include etag for this protection to apply. See Wikipedia and RFC 7232 for more details.
description string

Optional long form description of the use case for this AppProfile.
multiClusterRoutingUseAny Object

Use a multi-cluster routing policy that may pick any cluster.

This object should have the same structure as MultiClusterRoutingUseAny
singleClusterRouting Object

Use a single-cluster routing policy.

This object should have the same structure as SingleClusterRouting
Source:
See:

CheckConsistencyRequest

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

Properties:
Name Type Description
name string

The unique name of the Table for which to check replication consistency. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
consistencyToken string

The token created using GenerateConsistencyToken for the Table.
Source:
See:

CheckConsistencyResponse

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

Properties:
Name Type Description
consistent boolean

True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
Source:
See:

Cluster

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

Properties:
Name Type Description
name string

(OutputOnly) The unique name of the cluster. Values are of the form projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*.
location string

(CreationOnly) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/<project>/locations/<zone>.
state number

(OutputOnly) The current state of the cluster.

The number should be among the values of State
serveNodes number

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
defaultStorageType number

(CreationOnly) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

The number should be among the values of StorageType
Source:
See:

ClusterState

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

Properties:
Name Type Description
replicationState number

(OutputOnly) The state of replication for the table in this cluster.

The number should be among the values of ReplicationState
Source:
See:

ColumnFamily

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

Properties:
Name Type Description
gcRule Object

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.

This object should have the same structure as GcRule
Source:
See:

CreateAppProfileRequest

Request message for BigtableInstanceAdmin.CreateAppProfile.

Properties:
Name Type Description
parent string

The unique name of the instance in which to create the new app profile. Values are of the form projects/<project>/instances/<instance>.
appProfileId string

The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.
appProfile Object

The app profile to be created. Fields marked OutputOnly will be ignored.

This object should have the same structure as AppProfile
ignoreWarnings boolean

If true, ignore safety checks when creating the app profile.
Source:
See:

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this CreateCluster operation.

This object should have the same structure as CreateClusterRequest
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See:

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

Properties:
Name Type Description
parent string

The unique name of the instance in which to create the new cluster. Values are of the form projects/<project>/instances/<instance>.
clusterId string

The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.
cluster Object

The cluster to be created. Fields marked OutputOnly must be left blank.

This object should have the same structure as Cluster
Source:
See:

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this CreateInstance operation.

This object should have the same structure as CreateInstanceRequest
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See:

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

Properties:
Name Type Description
parent string

The unique name of the project in which to create the new instance. Values are of the form projects/<project>.
instanceId string

The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
instance Object

The instance to create. Fields marked OutputOnly must be left blank.

This object should have the same structure as Instance
clusters Object.<string, Object>

The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most two clusters can be specified.
Source:
See:

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.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this CreateTableFromSnapshot operation.

This object should have the same structure as CreateTableFromSnapshotRequest
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See:

CreateTableFromSnapshotRequest

Request message for 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.

Properties:
Name Type Description
parent string

The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.
tableId string

The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.
sourceSnapshot string

The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.
Source:
See:

CreateTableRequest

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

Properties:
Name Type Description
parent string

The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.
tableId string

The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.
table Object

The Table to create.

This object should have the same structure as Table
initialSplits Array.<Object>

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, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ).

Example:

  • Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
  • initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
  • Key assignment:
    • Tablet 1 [, apple) => {"a"}.
    • Tablet 2 [apple, customer_1) => {"apple", "custom"}.
    • Tablet 3 [customer_1, customer_2) => {"customer_1"}.
    • Tablet 4 [customer_2, other) => {"customer_2"}.
    • Tablet 5 [other, ) => {"other", "zz"}.

This object should have the same structure as Split
Source:
See:

DeleteAppProfileRequest

Request message for BigtableInstanceAdmin.DeleteAppProfile.

Properties:
Name Type Description
name string

The unique name of the app profile to be deleted. Values are of the form projects/<project>/instances/<instance>/appProfiles/<app_profile>.
ignoreWarnings boolean

If true, ignore safety checks when deleting the app profile.
Source:
See:

DeleteClusterRequest

Request message for BigtableInstanceAdmin.DeleteCluster.

Properties:
Name Type Description
name string

The unique name of the cluster to be deleted. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>.
Source:
See:

DeleteInstanceRequest

Request message for BigtableInstanceAdmin.DeleteInstance.

Properties:
Name Type Description
name string

The unique name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>.
Source:
See:

DeleteSnapshotRequest

Request message for 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.

Properties:
Name Type Description
name string

The unique name of the snapshot to be deleted. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.
Source:
See:

DeleteTableRequest

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

Properties:
Name Type Description
name string

The unique name of the table to be deleted. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
Source:
See:

DropRowRangeRequest

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

Properties:
Name Type Description
name string

The unique name of the table on which to drop a range of rows. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKeyPrefix Buffer

Delete all rows that start with this row key prefix. Prefix cannot be zero length.
deleteAllDataFromTable boolean

Delete all rows in the table. Setting this to false is a no-op.
Source:
See:

GcRule

Rule for determining which cells to delete during garbage collection.

Properties:
Name Type Description
maxNumVersions number

Delete all cells in a column except the most recent N.
maxAge Object

Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

This object should have the same structure as Duration
intersection Object

Delete cells that would be deleted by every nested rule.

This object should have the same structure as Intersection
union Object

Delete cells that would be deleted by any nested rule.

This object should have the same structure as Union
Source:
See:

GenerateConsistencyTokenRequest

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

Properties:
Name Type Description
name string

The unique name of the Table for which to create a consistency token. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
Source:
See:

GenerateConsistencyTokenResponse

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

Properties:
Name Type Description
consistencyToken string

The generated consistency token.
Source:
See:

GetAppProfileRequest

Request message for BigtableInstanceAdmin.GetAppProfile.

Properties:
Name Type Description
name string

The unique name of the requested app profile. Values are of the form projects/<project>/instances/<instance>/appProfiles/<app_profile>.
Source:
See:

GetClusterRequest

Request message for BigtableInstanceAdmin.GetCluster.

Properties:
Name Type Description
name string

The unique name of the requested cluster. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>.
Source:
See:

GetInstanceRequest

Request message for BigtableInstanceAdmin.GetInstance.

Properties:
Name Type Description
name string

The unique name of the requested instance. Values are of the form projects/<project>/instances/<instance>.
Source:
See:

GetSnapshotRequest

Request message for 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.

Properties:
Name Type Description
name string

The unique name of the requested snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.
Source:
See:

GetTableRequest

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

Properties:
Name Type Description
name string

The unique name of the requested table. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
view number

The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified.

The number should be among the values of View
Source:
See:

Instance

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from a single Cluster.

Properties:
Name Type Description
name string

(OutputOnly) The unique name of the instance. Values are of the form projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9].
displayName string

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 number

(OutputOnly) The current state of the instance.

The number should be among the values of State
type number

The type of the instance. Defaults to PRODUCTION.

The number should be among the values of Type
labels Object.<string, string>

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.

  • Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}.
  • No more than 64 labels can be associated with a given resource.
  • Keys and values must both be under 128 bytes.
Source:
See:

Intersection

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

Properties:
Name Type Description
rules Array.<Object>

Only delete cells which would be deleted by every element of rules.

This object should have the same structure as GcRule
Source:
See:

ListAppProfilesRequest

Request message for BigtableInstanceAdmin.ListAppProfiles.

Properties:
Name Type Description
parent string

The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/<project>/instances/<instance>. Use <instance> = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.
pageSize number

Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
pageToken string

The value of next_page_token returned by a previous call.
Source:
See:

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

Properties:
Name Type Description
appProfiles Array.<Object>

The list of requested app profiles.

This object should have the same structure as AppProfile
nextPageToken string

Set if not all app profiles could be returned in a single response. Pass this value to page_token in another request to get the next page of results.
failedLocations Array.<string>

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 app_profiles. Values are of the form projects/<project>/locations/<zone_id>
Source:
See:

ListClustersRequest

Request message for BigtableInstanceAdmin.ListClusters.

Properties:
Name Type Description
parent string

The unique name of the instance for which a list of clusters is requested. Values are of the form projects/<project>/instances/<instance>. Use <instance> = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.
pageToken string

DEPRECATED: This field is unused and ignored.
Source:
See:

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

Properties:
Name Type Description
clusters Array.<Object>

The list of requested clusters.

This object should have the same structure as Cluster
failedLocations Array.<string>

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 clusters, or may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>
nextPageToken string

DEPRECATED: This field is unused and ignored.
Source:
See:

ListInstancesRequest

Request message for BigtableInstanceAdmin.ListInstances.

Properties:
Name Type Description
parent string

The unique name of the project for which a list of instances is requested. Values are of the form projects/<project>.
pageToken string

DEPRECATED: This field is unused and ignored.
Source:
See:

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

Properties:
Name Type Description
instances Array.<Object>

The list of requested instances.

This object should have the same structure as Instance
failedLocations Array.<string>

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 instances, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>
nextPageToken string

DEPRECATED: This field is unused and ignored.
Source:
See:

ListSnapshotsRequest

Request message for 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.

Properties:
Name Type Description
parent string

The unique name of the cluster for which snapshots should be listed. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>. Use <cluster> = '-' to list snapshots for all clusters in an instance, e.g., projects/<project>/instances/<instance>/clusters/-.
pageSize number

The maximum number of snapshots to return per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
pageToken string

The value of next_page_token returned by a previous call.
Source:
See:

ListSnapshotsResponse

Response message for 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.

Properties:
Name Type Description
snapshots Array.<Object>

The snapshots present in the requested cluster.

This object should have the same structure as Snapshot
nextPageToken string

Set if not all snapshots could be returned in a single response. Pass this value to page_token in another request to get the next page of results.
Source:
See:

ListTablesRequest

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

Properties:
Name Type Description
parent string

The unique name of the instance for which tables should be listed. Values are of the form projects/<project>/instances/<instance>.
view number

The view to be applied to the returned tables' fields. Defaults to NAME_ONLY if unspecified; no others are currently supported.

The number should be among the values of View
pageSize number

Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
pageToken string

The value of next_page_token returned by a previous call.
Source:
See:

ListTablesResponse

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

Properties:
Name Type Description
tables Array.<Object>

The tables present in the requested instance.

This object should have the same structure as Table
nextPageToken string

Set if not all tables could be returned in a single response. Pass this value to page_token in another request to get the next page of results.
Source:
See:

Modification

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

Properties:
Name Type Description
id string

The ID of the column family to be modified.
create Object

Create a new column family with the specified schema, or fail if one already exists with the given ID.

This object should have the same structure as ColumnFamily
update Object

Update an existing column family to the specified schema, or fail if no column family exists with the given ID.

This object should have the same structure as ColumnFamily
drop boolean

Drop (delete) the column family with the given ID, or fail if no such family exists.
Source:
See:

ModifyColumnFamiliesRequest

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

Properties:
Name Type Description
name string

The unique name of the table whose families should be modified. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
modifications Array.<Object>

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).

This object should have the same structure as Modification
Source:
See:

MultiClusterRoutingUseAny

Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays. Choosing this option sacrifices read-your-writes consistency to improve availability.

Source:
See:

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

Properties:
Name Type Description
instance Object

The Instance which will (partially) replace the current value.

This object should have the same structure as Instance
updateMask Object

The subset of Instance fields which should be replaced. Must be explicitly set.

This object should have the same structure as FieldMask
Source:
See:

SingleClusterRouting

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

Properties:
Name Type Description
clusterId string

The cluster to which read/write requests should be routed.
allowTransactionalWrites boolean

Whether or not CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Source:
See:

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.

Properties:
Name Type Description
name string

(OutputOnly) The unique name of the snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.
sourceTable Object

(OutputOnly) The source table at the time the snapshot was taken.

This object should have the same structure as Table
dataSizeBytes number

(OutputOnly) The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.
createTime Object

(OutputOnly) The time when the snapshot is created.

This object should have the same structure as Timestamp
deleteTime Object

(OutputOnly) The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

This object should have the same structure as Timestamp
state number

(OutputOnly) The current state of the snapshot.

The number should be among the values of State
description string

(OutputOnly) Description of the snapshot.
Source:
See:

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.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this SnapshotTable operation.

This object should have the same structure as SnapshotTableRequest
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See:

SnapshotTableRequest

Request message for 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.

Properties:
Name Type Description
name string

The unique name of the table to have the snapshot taken. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
cluster string

The name of the cluster where the snapshot will be created in. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>.
snapshotId string

The ID by which the new snapshot should be referred to within the parent cluster, e.g., mysnapshot of the form: [_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot.
ttl Object

The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used.

This object should have the same structure as Duration
description string

Description of the snapshot.
Source:
See:

Split

An initial split point for a newly created table.

Properties:
Name Type Description
key Buffer

Row key to use as an initial tablet boundary.
Source:
See:

Table

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

Properties:
Name Type Description
name string

(OutputOnly) The unique name of the table. Values are of the form projects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL
clusterStates Object.<string, Object>

(OutputOnly) 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 replication_status. Views: REPLICATION_VIEW, FULL
columnFamilies Object.<string, Object>

(CreationOnly) The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL
granularity number

(CreationOnly) The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL

The number should be among the values of TimestampGranularity
Source:
See:

Union

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

Properties:
Name Type Description
rules Array.<Object>

Delete cells which would be deleted by any element of rules.

This object should have the same structure as GcRule
Source:
See:

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

Source:
See:

UpdateAppProfileRequest

Request message for BigtableInstanceAdmin.UpdateAppProfile.

Properties:
Name Type Description
appProfile Object

The app profile which will (partially) replace the current value.

This object should have the same structure as AppProfile
updateMask Object

The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

This object should have the same structure as FieldMask
ignoreWarnings boolean

If true, ignore safety checks when updating the app profile.
Source:
See:

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this UpdateCluster operation.

This object should have the same structure as Cluster
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See:

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

Properties:
Name Type Description
originalRequest Object

The request that prompted the initiation of this UpdateInstance operation.

This object should have the same structure as PartialUpdateInstanceRequest
requestTime Object

The time at which the original request was received.

This object should have the same structure as Timestamp
finishTime Object

The time at which the operation failed or was completed successfully.

This object should have the same structure as Timestamp
Source:
See: