Module api

Source

Structs§

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: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.
AuditLogConfig
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.
AutoscalingLimits
Limits for the number of nodes a Cluster can autoscale up/down to.
AutoscalingTargets
The Autoscaling targets for a Cluster. These determine the recommended nodes.
Backup
A backup of a Cloud Bigtable table.
BackupInfo
Information about a backup.
BigtableAdmin
Central instance to access all BigtableAdmin related resource activities
Binding
Associates members, or principals, with a role.
ChangeStreamConfig
Change stream configuration.
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.
ClusterAutoscalingConfig
Autoscaling config for a cluster.
ClusterConfig
Configuration for a cluster.
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.
ColumnFamilyStats
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.
CopyBackupRequest
The request for CopyBackup.
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); }
EncryptionConfig
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
EncryptionInfo
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.
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.
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.
HotTablet
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.
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.
ListHotTabletsResponse
Response message for BigtableInstanceAdmin.ListHotTablets.
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 a Google Cloud 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.
OperationGetCall
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.
OperationMethods
A builder providing access to all methods supported on operation resources. It is not used directly, but through the BigtableAdmin hub.
OperationProjectOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
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, 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.
ProjectInstanceAppProfileCreateCall
Creates an app profile within an instance.
ProjectInstanceAppProfileDeleteCall
Deletes an app profile from an instance.
ProjectInstanceAppProfileGetCall
Gets information about an app profile.
ProjectInstanceAppProfileListCall
Lists information about app profiles in an instance.
ProjectInstanceAppProfilePatchCall
Updates an app profile within an instance.
ProjectInstanceClusterBackupCopyCall
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
ProjectInstanceClusterBackupCreateCall
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.
ProjectInstanceClusterBackupDeleteCall
Deletes a pending or completed Cloud Bigtable backup.
ProjectInstanceClusterBackupGetCall
Gets metadata on a pending or completed Cloud Bigtable Backup.
ProjectInstanceClusterBackupGetIamPolicyCall
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
ProjectInstanceClusterBackupListCall
Lists Cloud Bigtable backups. Returns both completed and pending backups.
ProjectInstanceClusterBackupPatchCall
Updates a pending or completed Cloud Bigtable Backup.
ProjectInstanceClusterBackupSetIamPolicyCall
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
ProjectInstanceClusterBackupTestIamPermissionCall
Returns permissions that the caller has on the specified Table or Backup resource.
ProjectInstanceClusterCreateCall
Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
ProjectInstanceClusterDeleteCall
Deletes a cluster from an instance.
ProjectInstanceClusterGetCall
Gets information about a cluster.
ProjectInstanceClusterHotTabletListCall
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
ProjectInstanceClusterListCall
Lists information about clusters in an instance.
ProjectInstanceClusterPartialUpdateClusterCall
Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
ProjectInstanceClusterUpdateCall
Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
ProjectInstanceCreateCall
Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
ProjectInstanceDeleteCall
Delete an instance from a project.
ProjectInstanceGetCall
Gets information about an instance.
ProjectInstanceGetIamPolicyCall
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
ProjectInstanceListCall
Lists information about instances in a project.
ProjectInstancePartialUpdateInstanceCall
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.
ProjectInstanceSetIamPolicyCall
Sets the access control policy on an instance resource. Replaces any existing policy.
ProjectInstanceTableCheckConsistencyCall
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.
ProjectInstanceTableCreateCall
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.
ProjectInstanceTableDeleteCall
Permanently deletes a specified table and all of its data.
ProjectInstanceTableDropRowRangeCall
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. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice.
ProjectInstanceTableGenerateConsistencyTokenCall
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.
ProjectInstanceTableGetCall
Gets metadata information about the specified table.
ProjectInstanceTableGetIamPolicyCall
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
ProjectInstanceTableListCall
Lists all tables served from a specified instance.
ProjectInstanceTableModifyColumnFamilyCall
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.
ProjectInstanceTablePatchCall
Updates a specified table.
ProjectInstanceTableRestoreCall
Create a new table by restoring from a completed 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.
ProjectInstanceTableSetIamPolicyCall
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
ProjectInstanceTableTestIamPermissionCall
Returns permissions that the caller has on the specified Table or Backup resource.
ProjectInstanceTableUndeleteCall
Restores a specified table which was accidentally deleted.
ProjectInstanceTestIamPermissionCall
Returns permissions that the caller has on the specified instance resource.
ProjectInstanceUpdateCall
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.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the BigtableAdmin hub.
RestoreInfo
Information about a table restore.
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.
StandardIsolation
Standard options for isolating this app profile’s traffic from other use cases.
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.
TableStats
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.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
UndeleteTableRequest
Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable
Union
A GcRule which deletes cells matching any of the given rules.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.