googleapis.bigtableadmin.v2 library

Classes

AppProfile

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

AuditConfig

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:[e-mail]" }, { "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:[e-mail]" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [e-mail] from DATA_READ logging, and [e-mail] from DATA_WRITE logging.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:[e-mail]" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [e-mail] from DATA_READ logging.

Backup

A backup of a Cloud Bigtable table.

BackupInfo

Information about a backup.

BigtableadminApi

Administer your Cloud Bigtable tables and instances.

Binding

Associates members with a role.

CheckConsistencyRequest

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

CheckConsistencyResponse

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

Cluster

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

ClusterState

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

ColumnFamily

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

CreateBackupMetadata

Metadata type for the operation returned by CreateBackup.

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

CreateTableRequest

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

DropRowRangeRequest

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

Empty

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 {}.

Expr

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.

FailureTrace

Added to the error payload.

Frame

GcRule

Rule for determining which cells to delete during garbage collection.

GenerateConsistencyTokenRequest

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

GenerateConsistencyTokenResponse

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

GetIamPolicyRequest

Request message for GetIamPolicy method.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

Instance

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

Intersection

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

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

ListBackupsResponse

The response for ListBackups.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListTablesResponse

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

Location

A resource that represents Google Cloud Platform location.

Modification

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

ModifyColumnFamiliesRequest

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

MultiClusterRoutingUseAny

Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationProgress

Encapsulates progress related information for a Cloud Bigtable long running operation.

OperationsProjectsOperationsResourceApi

OperationsProjectsResourceApi

OperationsResourceApi

OptimizeRestoredTableMetadata

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.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

Policy

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:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" }, { "role": "roles/resourcemanager.organizationViewer", "members": "user:[e-mail]" , "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:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] 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.

ProjectsInstancesAppProfilesResourceApi

ProjectsInstancesClustersBackupsResourceApi

ProjectsInstancesClustersResourceApi

ProjectsInstancesResourceApi

ProjectsInstancesTablesResourceApi

ProjectsLocationsResourceApi

ProjectsResourceApi

RestoreInfo

Information about a table restore.

RestoreTableMetadata

Metadata type for the long-running operation returned by RestoreTable.

RestoreTableRequest

The request for RestoreTable.

SetIamPolicyRequest

Request message for SetIamPolicy method.

SingleClusterRouting

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

Split

An initial split point for a newly created table.

Status

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.

Table

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

TableProgress

Progress info for copying a table's data to the new cluster.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Union

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

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

Constants

USER_AGENT → const String

'dart-api-client bigtableadmin/v2'

Exceptions / Errors

ApiRequestError

Represents a general error reported by the API endpoint.

DetailedApiRequestError

Represents a specific error reported by the API endpoint.