package google.bigtable.admin.v2
Get desktop application:
View/edit binary Protocol Buffers messages
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.
Create an instance within a project.
Gets information about an instance.
Request message for BigtableInstanceAdmin.GetInstance.
string name = 1
The unique name of the requested instance. Values are of the form `projects/<project>/instances/<instance>`.
Lists information about instances in a project.
Request message for BigtableInstanceAdmin.ListInstances.
string parent = 1
The unique name of the project for which a list of instances is requested. Values are of the form `projects/<project>`.
string page_token = 2
DEPRECATED: This field is unused and ignored.
Response message for BigtableInstanceAdmin.ListInstances.
repeated instances = 1
The list of requested instances.
repeated string failed_locations = 2
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>`
string next_page_token = 3
DEPRECATED: This field is unused and ignored.
Updates an instance within a project.
Partially updates an instance within a project.
Delete an instance from a project.
Request message for BigtableInstanceAdmin.DeleteInstance.
string name = 1
The unique name of the instance to be deleted. Values are of the form `projects/<project>/instances/<instance>`.
Creates a cluster within an instance.
Gets information about a cluster.
Request message for BigtableInstanceAdmin.GetCluster.
string name = 1
The unique name of the requested cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`.
Lists information about clusters in an instance.
Request message for BigtableInstanceAdmin.ListClusters.
string parent = 1
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/-`.
string page_token = 2
DEPRECATED: This field is unused and ignored.
Response message for BigtableInstanceAdmin.ListClusters.
repeated clusters = 1
The list of requested clusters.
repeated string failed_locations = 2
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>`
string next_page_token = 3
DEPRECATED: This field is unused and ignored.
Updates a cluster within an instance.
Deletes a cluster from an instance.
Request message for BigtableInstanceAdmin.DeleteCluster.
string name = 1
The unique name of the cluster to be deleted. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`.
Creates an app profile within an instance.
Request message for BigtableInstanceAdmin.CreateAppProfile.
string parent = 1
The unique name of the instance in which to create the new app profile. Values are of the form `projects/<project>/instances/<instance>`.
string app_profile_id = 2
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`.
optional app_profile = 3
The app profile to be created. Fields marked `OutputOnly` will be ignored.
bool ignore_warnings = 4
If true, ignore safety checks when creating the app profile.
Gets information about an app profile.
Request message for BigtableInstanceAdmin.GetAppProfile.
string name = 1
The unique name of the requested app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
Lists information about app profiles in an instance.
Request message for BigtableInstanceAdmin.ListAppProfiles.
string parent = 1
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/-`.
int32 page_size = 3
Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
string page_token = 2
The value of `next_page_token` returned by a previous call.
Response message for BigtableInstanceAdmin.ListAppProfiles.
repeated app_profiles = 1
The list of requested app profiles.
string next_page_token = 2
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.
repeated string failed_locations = 3
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>`
Updates an app profile within an instance.
Request message for BigtableInstanceAdmin.UpdateAppProfile.
optional app_profile = 1
The app profile which will (partially) replace the current value.
optional update_mask = 2
The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
bool ignore_warnings = 3
If true, ignore safety checks when updating the app profile.
Deletes an app profile from an instance.
Request message for BigtableInstanceAdmin.DeleteAppProfile.
string name = 1
The unique name of the app profile to be deleted. Values are of the form `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
bool ignore_warnings = 2
If true, ignore safety checks when deleting the app profile.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Sets the access control policy on an instance resource. Replaces any existing policy.
Returns permissions that the caller has on the specified instance resource.
Service for creating, configuring, and deleting Cloud Bigtable tables. Provides access to the table schemas only, not the data stored within the tables.
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.
message
bigtable_table_admin.proto:217Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]
string parent = 1
The unique name of the instance in which to create the table. Values are of the form `projects/<project>/instances/<instance>`.
string table_id = 2
The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
optional table = 3
The Table to create.
repeated initial_splits = 4
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"}.`
Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance. 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.
Lists all tables served from a specified instance.
message
bigtable_table_admin.proto:298Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
string parent = 1
The unique name of the instance for which tables should be listed. Values are of the form `projects/<project>/instances/<instance>`.
Table.View view = 2
The view to be applied to the returned tables' fields. Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
int32 page_size = 4
Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
string page_token = 3
The value of `next_page_token` returned by a previous call.
message
bigtable_table_admin.proto:317Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
repeated tables = 1
The tables present in the requested instance.
string next_page_token = 2
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.
Gets metadata information about the specified table.
message
bigtable_table_admin.proto:329Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]
string name = 1
The unique name of the requested table. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
Table.View view = 2
The view to be applied to the returned table's fields. Defaults to `SCHEMA_VIEW` if unspecified.
Permanently deletes a specified table and all of its data.
message
bigtable_table_admin.proto:342Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
string name = 1
The unique name of the table to be deleted. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
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.
message
bigtable_table_admin.proto:351Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]
string name = 1
The unique name of the table whose families should be modified. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
repeated modifications = 2
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).
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.
message
bigtable_table_admin.proto:279Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
string name = 1
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>`.
oneof target
Delete all rows or by prefix.
bytes row_key_prefix = 2
Delete all rows that start with this row key prefix. Prefix cannot be zero length.
bool delete_all_data_from_table = 3
Delete all rows in the table. Setting this to false is a no-op.
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.
message
bigtable_table_admin.proto:387Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
string name = 1
The unique name of the Table for which to create a consistency token. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
message
bigtable_table_admin.proto:396Response message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
string consistency_token = 1
The generated consistency token.
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.
message
bigtable_table_admin.proto:403Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
string name = 1
The unique name of the Table for which to check replication consistency. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string consistency_token = 2
The token created using GenerateConsistencyToken for the Table.
message
bigtable_table_admin.proto:415Response message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
bool consistent = 1
True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance. 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.
Gets metadata information about the specified snapshot. 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.
message
bigtable_table_admin.proto:462Request 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.
string name = 1
The unique name of the requested snapshot. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
Lists all snapshots associated with the specified cluster. 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.
message
bigtable_table_admin.proto:476Request 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.
string parent = 1
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/-`.
int32 page_size = 2
The maximum number of snapshots to return per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
string page_token = 3
The value of `next_page_token` returned by a previous call.
message
bigtable_table_admin.proto:499Response 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.
repeated snapshots = 1
The snapshots present in the requested cluster.
string next_page_token = 2
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.
Permanently deletes the specified snapshot. 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.
message
bigtable_table_admin.proto:516Request 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.
string name = 1
The unique name of the snapshot to be deleted. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set.
Sets the access control policy on a table resource. Replaces any existing policy.
Returns permissions that the caller has on the specified table resource.
message
instance.proto:158A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
Used as response type in: BigtableInstanceAdmin.CreateAppProfile, BigtableInstanceAdmin.GetAppProfile
Used as field type in: , ,
string name = 1
(`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]*`.
string etag = 2
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](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
string description = 3
Optional long form description of the use case for this AppProfile.
oneof routing_policy
The routing policy for all read/write requests which use this app profile. A value must be explicitly set.
multi_cluster_routing_use_any = 5
Use a multi-cluster routing policy that may pick any cluster.
single_cluster_routing = 6
Use a single-cluster routing policy.
message
instance.proto:163Read/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.
Used in:
(message has no fields)
message
instance.proto:168Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency, but does not improve availability.
Used in:
string cluster_id = 1
The cluster to which read/write requests should be routed.
bool allow_transactional_writes = 2
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.
message
instance.proto:104A 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].
Used as request type in: BigtableInstanceAdmin.UpdateCluster
Used as response type in: BigtableInstanceAdmin.GetCluster
Used as field type in: , , ,
string name = 1
(`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`.
string location = 2
(`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>`.
Cluster.State state = 3
(`OutputOnly`) The current state of the cluster.
int32 serve_nodes = 4
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
StorageType default_storage_type = 5
(`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
Possible states of a cluster.
Used in:
STATE_NOT_KNOWN = 0
The state of the cluster could not be determined.
READY = 1
The cluster has been successfully created and is ready to serve requests.
CREATING = 2
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 = 3
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 = 4
The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.
message
table.proto:123A set of columns within a table which share a common configuration.
Used in: ,
optional gc_rule = 1
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.
The metadata for the Operation returned by CreateCluster.
optional original_request = 1
The request that prompted the initiation of this CreateCluster operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.
Request message for BigtableInstanceAdmin.CreateCluster.
Used as request type in: BigtableInstanceAdmin.CreateCluster
Used as field type in:
string parent = 1
The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`.
string cluster_id = 2
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`.
optional cluster = 3
The cluster to be created. Fields marked `OutputOnly` must be left blank.
The metadata for the Operation returned by CreateInstance.
optional original_request = 1
The request that prompted the initiation of this CreateInstance operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.
Request message for BigtableInstanceAdmin.CreateInstance.
Used as request type in: BigtableInstanceAdmin.CreateInstance
Used as field type in:
string parent = 1
The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`.
string instance_id = 2
The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
optional instance = 3
The instance to create. Fields marked `OutputOnly` must be left blank.
map<string, > clusters = 4
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.
message
bigtable_table_admin.proto:546The 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.
optional original_request = 1
The request that prompted the initiation of this CreateTableFromSnapshot operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.
message
bigtable_table_admin.proto:261Request 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.
Used as request type in: BigtableTableAdmin.CreateTableFromSnapshot
Used as field type in:
string parent = 1
The unique name of the instance in which to create the table. Values are of the form `projects/<project>/instances/<instance>`.
string table_id = 2
The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
string source_snapshot = 3
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>`.
message
bigtable_table_admin.proto:219An initial split point for a newly created table.
Used in:
bytes key = 1
Row key to use as an initial tablet boundary.
message
table.proto:134Rule for determining which cells to delete during garbage collection.
Used in: , ,
oneof rule
Garbage collection rules.
int32 max_num_versions = 1
Delete all cells in a column except the most recent N.
max_age = 2
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 = 3
Delete cells that would be deleted by every nested rule.
union = 4
Delete cells that would be deleted by any nested rule.
message
table.proto:136A GcRule which deletes cells matching all of the given rules.
Used in:
repeated rules = 1
Only delete cells which would be deleted by every element of `rules`.
message
table.proto:142A GcRule which deletes cells matching any of the given rules.
Used in:
repeated rules = 1
Delete cells which would be deleted by any element of `rules`.
message
instance.proto:34A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them. All tables in an instance are served from a single [Cluster][google.bigtable.admin.v2.Cluster].
Used as request type in: BigtableInstanceAdmin.UpdateInstance
Used as response type in: BigtableInstanceAdmin.GetInstance, BigtableInstanceAdmin.UpdateInstance
Used as field type in: , ,
string name = 1
(`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
string display_name = 2
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.
Instance.State state = 3
(`OutputOnly`) The current state of the instance.
Instance.Type type = 4
The type of the instance. Defaults to `PRODUCTION`.
map<string, string> labels = 5
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.
Possible states of an instance.
Used in:
STATE_NOT_KNOWN = 0
The state of the instance could not be determined.
READY = 1
The instance has been successfully created and can serve requests to its tables.
CREATING = 2
The instance is currently being created, and may be destroyed if the creation process encounters an error.
The type of the instance.
Used in:
TYPE_UNSPECIFIED = 0
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 = 1
An instance meant for production use. `serve_nodes` must be set on the cluster.
DEVELOPMENT = 2
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.
message
bigtable_table_admin.proto:353A create, update, or delete of a particular column family.
Used in:
string id = 1
The ID of the column family to be modified.
oneof mod
Column familiy modifications.
create = 2
Create a new column family with the specified schema, or fail if one already exists with the given ID.
update = 3
Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
bool drop = 4
Drop (delete) the column family with the given ID, or fail if no such family exists.
Request message for BigtableInstanceAdmin.PartialUpdateInstance.
Used as request type in: BigtableInstanceAdmin.PartialUpdateInstance
Used as field type in:
optional instance = 1
The Instance which will (partially) replace the current value.
optional update_mask = 2
The subset of Instance fields which should be replaced. Must be explicitly set.
message
table.proto:172A 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.
Used as response type in: BigtableTableAdmin.GetSnapshot
Used as field type in:
string name = 1
(`OutputOnly`) The unique name of the snapshot. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
optional source_table = 2
(`OutputOnly`) The source table at the time the snapshot was taken.
int64 data_size_bytes = 3
(`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.
optional create_time = 4
(`OutputOnly`) The time when the snapshot is created.
optional delete_time = 5
(`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.
Snapshot.State state = 6
(`OutputOnly`) The current state of the snapshot.
string description = 7
(`OutputOnly`) Description of the snapshot.
Possible states of a snapshot.
Used in:
STATE_NOT_KNOWN = 0
The state of the snapshot could not be determined.
READY = 1
The snapshot has been successfully created and can serve all requests.
CREATING = 2
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.
message
bigtable_table_admin.proto:529The 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.
optional original_request = 1
The request that prompted the initiation of this SnapshotTable operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.
message
bigtable_table_admin.proto:428Request 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.
Used as request type in: BigtableTableAdmin.SnapshotTable
Used as field type in:
string name = 1
The unique name of the table to have the snapshot taken. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string cluster = 2
The name of the cluster where the snapshot will be created in. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`.
string snapshot_id = 3
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`.
optional ttl = 4
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.
string description = 5
Description of the snapshot.
Storage media types for persisting Bigtable data.
Used in:
STORAGE_TYPE_UNSPECIFIED = 0
The user did not specify a storage type.
SSD = 1
Flash (SSD) storage should be used.
HDD = 2
Magnetic drive (HDD) storage should be used.
message
table.proto:33A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Used as response type in: BigtableTableAdmin.CreateTable, BigtableTableAdmin.GetTable, BigtableTableAdmin.ModifyColumnFamilies
Used as field type in: , ,
string name = 1
(`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`
map<string, > cluster_states = 2
(`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`
map<string, > column_families = 3
(`CreationOnly`) The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
Table.TimestampGranularity granularity = 4
(`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`
message
table.proto:35The state of a table's data in a particular cluster.
Used in:
ClusterState.ReplicationState replication_state = 1
(`OutputOnly`) The state of replication for the table in this cluster.
Table replication states.
Used in:
STATE_NOT_KNOWN = 0
The replication state of the table is unknown in this cluster.
INITIALIZING = 1
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 = 2
The table is temporarily unable to serve Data API requests from this cluster due to planned internal maintenance.
UNPLANNED_MAINTENANCE = 3
The table is temporarily unable to serve Data API requests from this cluster due to unplanned or emergency maintenance.
READY = 4
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.
Possible timestamp granularities to use when keeping multiple versions of data in a table.
Used in:
TIMESTAMP_GRANULARITY_UNSPECIFIED = 0
The user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
MILLIS = 1
The table keeps data versioned at a granularity of 1ms.
Defines a view over a table's fields.
Used in: ,
VIEW_UNSPECIFIED = 0
Uses the default view for each method as documented in its request.
NAME_ONLY = 1
Only populates `name`.
SCHEMA_VIEW = 2
Only populates `name` and fields related to the table's schema.
REPLICATION_VIEW = 3
Only populates `name` and fields related to the table's replication state.
FULL = 4
Populates all fields.
The metadata for the Operation returned by UpdateAppProfile.
(message has no fields)
The metadata for the Operation returned by UpdateCluster.
optional original_request = 1
The request that prompted the initiation of this UpdateCluster operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.
The metadata for the Operation returned by UpdateInstance.
optional original_request = 1
The request that prompted the initiation of this UpdateInstance operation.
optional request_time = 2
The time at which the original request was received.
optional finish_time = 3
The time at which the operation failed or was completed successfully.