Module google_bigtableadmin2::api [−][src]
Structs
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.
A backup of a Cloud Bigtable table.
Information about a backup.
Central instance to access all BigtableAdmin related resource activities
Associates members with a role.
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.
The state of a table’s data in a particular cluster.
A set of columns within a table which share a common configuration.
Request message for BigtableInstanceAdmin.CreateInstance.
Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
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); } The JSON representation for Empty is empty JSON object {}.
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.
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.
The response for ListBackups.
Response message for BigtableInstanceAdmin.ListClusters.
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 Google Cloud Platform 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.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
A builder providing access to all methods supported on operation resources.
It is not used directly, but through the BigtableAdmin hub.
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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 to a single role. Members 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.
Creates an app profile within an instance.
Deletes an app profile from an instance.
Gets information about an app profile.
Lists information about app profiles in an instance.
Updates an app profile within an instance.
Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
Deletes a pending or completed Cloud Bigtable backup.
Gets metadata on a pending or completed Cloud Bigtable Backup.
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
Lists Cloud Bigtable backups. Returns both completed and pending backups.
Updates a pending or completed Cloud Bigtable Backup.
Sets the access control policy on a Table resource. Replaces any existing policy.
Returns permissions that the caller has on the specified table resource.
Creates a cluster within an instance.
Deletes a cluster from an instance.
Gets information about a cluster.
Lists information about clusters in an instance.
Updates a cluster within an instance.
Create an instance within a project.
Delete an instance from a project.
Gets information about an instance.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Lists information about instances in a project.
Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
Sets the access control policy on an instance resource. Replaces any existing policy.
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.
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.
Permanently deletes a specified table and all of its data.
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.
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.
Gets metadata information about the specified table.
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
Lists all tables served from a specified instance.
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.
Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
Sets the access control policy on a Table resource. Replaces any existing policy.
Returns permissions that the caller has on the specified table resource.
Returns permissions that the caller has on the specified instance resource.
Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
Gets information about a location.
Lists information about the supported locations for this service.
A builder providing access to all methods supported on project resources.
It is not used directly, but through the BigtableAdmin hub.
Information about a table restore.
The request for RestoreTable.
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.
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.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.
A GcRule which deletes cells matching any of the given rules.
Enums
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.