View Source API Reference google_api_bigtable_admin v0.30.2
Modules
API client metadata for GoogleApi.BigtableAdmin.V2.
API calls for all endpoints tagged Operations
.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.BigtableAdmin.V2.
A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com
from DATA_READ logging, and aliya@example.com
from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
An Authorized View of a Cloud Bigtable Table.
Defines an automated backup policy for a table
Limits for the number of nodes a Cluster can autoscale up/down to.
The Autoscaling targets for a Cluster. These determine the recommended nodes.
A backup of a Cloud Bigtable table.
Information about a backup.
Associates members
, or principals, with a role
.
Change stream configuration.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Autoscaling config for a cluster.
Configuration for a cluster.
The state of a table's data in a particular cluster.
A set of columns within a table which share a common configuration.
Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information. Everything below is approximate, unless otherwise specified.
Metadata type for the google.longrunning.Operation returned by CopyBackup.
The request for CopyBackup.
The metadata for the Operation returned by CreateAuthorizedView.
The request for CreateAuthorizedView
Metadata type for the operation returned by CreateBackup.
The metadata for the Operation returned by CreateCluster.
Request message for BigtableInstanceAdmin.CreateCluster.
The metadata for the Operation returned by CreateInstance.
Request message for BigtableInstanceAdmin.CreateInstance.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.
Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Rule for determining which cells to delete during garbage collection.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
Request message for GetIamPolicy
method.
Encapsulates settings provided to GetIamPolicy.
Subsets of a column family that are included in this AuthorizedView.
Defines a simple AuthorizedView that is a subset of the underlying Table.
A value that combines incremental updates into a summarized value. Data is never directly written or read using type Aggregate
. Writes provide either the input_type
or state_type
, and reads always return the state_type
.
Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: Int64
(the unique count estimate)
Computes the max of the input values. Allowed input: Int64
State: same as input
Computes the min of the input values. Allowed input: Int64
State: same as input
Computes the sum of the input values. Allowed input: Int64
State: same as input
An ordered list of elements of a given type. Values of type Array
are stored in Value.array_value
.
bool Values of type Bool
are stored in Value.bool_value
.
Bytes Values of type Bytes
are stored in Value.bytes_value
.
Rules used to convert to or from lower level types.
Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported.
Date Values of type Date
are stored in Value.date_value
.
Float32 Values of type Float32
are stored in Value.float_value
.
Float64 Values of type Float64
are stored in Value.float_value
.
Int64 Values of type Int64
are stored in Value.int_value
.
Rules used to convert to or from lower level types.
Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery BINARY
encoding - HBase Bytes.toBytes
- Java ByteBuffer.putLong()
with ByteOrder.BIG_ENDIAN
A mapping of keys to values of a given type. Values of type Map
are stored in a Value.array_value
where each entry is another Value.array_value
with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the last value takes precedence.
String Values of type String
are stored in Value.string_value
.
Rules used to convert to or from lower level types.
UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery TEXT
encoding - HBase Bytes.toBytes
- Java String#getBytes(StandardCharsets.UTF_8)
Deprecated: prefer the equivalent Utf8Bytes
.
A structured data value, consisting of fields which map to dynamically typed values. Values of type Struct
are stored in Value.array_value
where entries are in the same order and number as field_types
.
A struct field and its type.
Timestamp Values of type Timestamp
are stored in Value.timestamp_value
.
A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.
A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
A GcRule which deletes cells matching all of the given rules.
Response message for BigtableInstanceAdmin.ListAppProfiles.
Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews
The response for ListBackups.
Response message for BigtableInstanceAdmin.ListClusters.
Response message for BigtableInstanceAdmin.ListHotTablets.
Response message for BigtableInstanceAdmin.ListInstances.
The response message for Locations.ListLocations.
The response message for Operations.ListOperations.
Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
A resource that represents a Google Cloud location.
A create, update, or delete of a particular column family.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
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.
This resource represents a long-running operation that is the result of a network API call.
Encapsulates progress related information for a Cloud Bigtable long running operation.
Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored table. This long-running operation is automatically created by the system after the successful completion of a table restore, and cannot be cancelled.
The metadata for the Operation returned by PartialUpdateCluster.
Request message for BigtableInstanceAdmin.PartialUpdateCluster.
Request message for BigtableInstanceAdmin.PartialUpdateInstance.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy
is a collection of bindings
. A binding
binds one or more members
, or principals, to a single role
. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role
is a named list of permissions; each role
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical expression that allows access to a resource only if the expression evaluates to true
. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3
For a description of IAM and its features, see the IAM documentation.
Information about a table restore.
Metadata type for the long-running operation returned by RestoreTable.
The request for RestoreTable.
If enabled, Bigtable will route the request based on the row key of the request, rather than randomly. Instead, each row key will be assigned to a cluster, and will stick to that cluster. If clusters are added or removed, then this may affect which row keys stick to which clusters. To avoid this, users can use a cluster group to specify which clusters are to be used. In this case, new clusters that are not a part of the cluster group will not be routed to, and routing will be unaffected by the new cluster. Moreover, clusters specified in the cluster group cannot be deleted unless removed from the cluster group.
Request message for SetIamPolicy
method.
Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
An initial split point for a newly created table.
Standard options for isolating this app profile's traffic from other use cases.
Checks that all writes before the consistency token was generated are replicated in every cluster and readable.
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Progress info for copying a table's data to the new cluster.
Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.
Request message for TestIamPermissions
method.
Response message for TestIamPermissions
method.
Type
represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each Type
includes an Encoding
which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that Encode(X) <= Encode(Y)
if and only if X <= Y
. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if X != Y
then Encode(X) != Encode(Y)
. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because INT64(1) > INT64(-1)
, but STRING("-00001") > STRING("00001")
.
Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable
A GcRule which deletes cells matching any of the given rules.
The metadata for the Operation returned by UpdateAppProfile.
Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView.
The request for UpdateAuthorizedView.
The metadata for the Operation returned by UpdateCluster.
The metadata for the Operation returned by UpdateInstance.
Metadata type for the operation returned by UpdateTable.