bigtableadmin library

Classes

AppProfile
Creates an app profile within an instance.
AppProfileArgs
The set of arguments for AppProfile. The set of arguments for AppProfile.
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.
AuditConfigResponse
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.
AuditLogConfigResponse
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.
AutoscalingLimitsResponse
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.
AutoscalingTargetsResponse
The Autoscaling targets for a Cluster. These determine the recommended nodes.
Backup
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. Auto-naming is currently not supported for this resource.
BackupArgs
The set of arguments for Backup. The set of arguments for Backup.
BackupInfoResponse
Information about a backup.
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
ChangeStreamConfig
Change stream configuration.
ChangeStreamConfigResponse
Change stream configuration.
Cluster
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.
ClusterArgs
The set of arguments for Cluster. The set of arguments for Cluster.
ClusterAutoscalingConfig
Autoscaling config for a cluster.
ClusterAutoscalingConfigResponse
Autoscaling config for a cluster.
ClusterConfig
Configuration for a cluster.
ClusterConfigResponse
Configuration for a cluster.
EncryptionConfig
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
EncryptionConfigResponse
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
EncryptionInfoResponse
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.
ExprResponse
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.
GetAppProfileArgs
Arguments for getAppProfile. Arguments for getAppProfile.
GetAppProfileResult
Result data returned by getAppProfile.
GetBackupArgs
Arguments for getBackup. Arguments for getBackup.
GetBackupResult
Result data returned by getBackup.
GetClusterArgs
Arguments for getCluster. Arguments for getCluster.
GetClusterResult
Result data returned by getCluster.
GetInstanceArgs
Arguments for getInstance. Arguments for getInstance.
GetInstanceClusterBackupIamPolicyArgs
Arguments for getInstanceClusterBackupIamPolicy. Arguments for getInstanceClusterBackupIamPolicy.
GetInstanceClusterBackupIamPolicyResult
Result data returned by getInstanceClusterBackupIamPolicy.
GetInstanceIamPolicyArgs
Arguments for getInstanceIamPolicy. Arguments for getInstanceIamPolicy.
GetInstanceIamPolicyResult
Result data returned by getInstanceIamPolicy.
GetInstanceResult
Result data returned by getInstance.
GetInstanceTableIamPolicyArgs
Arguments for getInstanceTableIamPolicy. Arguments for getInstanceTableIamPolicy.
GetInstanceTableIamPolicyResult
Result data returned by getInstanceTableIamPolicy.
GetTableArgs
Arguments for getTable. Arguments for getTable.
GetTableResult
Result data returned by getTable.
Instance
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.
InstanceArgs
The set of arguments for Instance. The set of arguments for Instance.
InstanceClusterBackupIamBinding
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
InstanceClusterBackupIamBindingArgs
The set of arguments for InstanceClusterBackupIamBinding. The set of arguments for InstanceClusterBackupIamBinding.
InstanceClusterBackupIamMember
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
InstanceClusterBackupIamMemberArgs
The set of arguments for InstanceClusterBackupIamMember. The set of arguments for InstanceClusterBackupIamMember.
InstanceClusterBackupIamPolicy
Sets the access control policy on a Table or Backup resource. Replaces any existing policy. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceClusterBackupIamPolicyArgs
The set of arguments for InstanceClusterBackupIamPolicy. The set of arguments for InstanceClusterBackupIamPolicy.
InstanceIamBinding
Sets the access control policy on an instance resource. Replaces any existing policy.
InstanceIamBindingArgs
The set of arguments for InstanceIamBinding. The set of arguments for InstanceIamBinding.
InstanceIamMember
Sets the access control policy on an instance resource. Replaces any existing policy.
InstanceIamMemberArgs
The set of arguments for InstanceIamMember. The set of arguments for InstanceIamMember.
InstanceIamPolicy
Sets the access control policy on an instance resource. Replaces any existing policy. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceIamPolicyArgs
The set of arguments for InstanceIamPolicy. The set of arguments for InstanceIamPolicy.
InstanceTableIamBinding
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
InstanceTableIamBindingArgs
The set of arguments for InstanceTableIamBinding. The set of arguments for InstanceTableIamBinding.
InstanceTableIamMember
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
InstanceTableIamMemberArgs
The set of arguments for InstanceTableIamMember. The set of arguments for InstanceTableIamMember.
InstanceTableIamPolicy
Sets the access control policy on a Table or Backup resource. Replaces any existing policy. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceTableIamPolicyArgs
The set of arguments for InstanceTableIamPolicy. The set of arguments for InstanceTableIamPolicy.
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.
MultiClusterRoutingUseAnyResponse
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.
RestoreInfoResponse
Information about a table restore.
SingleClusterRouting
Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
SingleClusterRoutingResponse
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.
StandardIsolationResponse
Standard options for isolating this app profile's traffic from other use cases.
StatusResponse
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
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.
TableArgs
The set of arguments for Table. The set of arguments for Table.
TableStatsResponse
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.

Enums

AppProfilePriority
This field has been deprecated in favor of standard_isolation.priority. If you set this field, standard_isolation.priority will be set instead. The priority of requests sent using this app profile.
AuditLogConfigLogType
The log type that this config enables.
ClusterDefaultStorageType
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
InstanceType
The type of the instance. Defaults to PRODUCTION.
StandardIsolationPriority
The priority of requests sent using this app profile.
TableGranularity
Immutable. 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.

Functions

getAppProfile(GetAppProfileArgs args, {InvokeOptions? options}) → Future<GetAppProfileResult>
Gets information about an app profile. args Arguments passed to this invoke. Arguments for getAppProfile. options Invoke options controlling this call.
getBackup(GetBackupArgs args, {InvokeOptions? options}) → Future<GetBackupResult>
Gets metadata on a pending or completed Cloud Bigtable Backup. args Arguments passed to this invoke. Arguments for getBackup. options Invoke options controlling this call.
getCluster(GetClusterArgs args, {InvokeOptions? options}) → Future<GetClusterResult>
Gets information about a cluster. args Arguments passed to this invoke. Arguments for getCluster. options Invoke options controlling this call.
getInstance(GetInstanceArgs args, {InvokeOptions? options}) → Future<GetInstanceResult>
Gets information about an instance. args Arguments passed to this invoke. Arguments for getInstance. options Invoke options controlling this call.
getInstanceClusterBackupIamPolicy(GetInstanceClusterBackupIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceClusterBackupIamPolicyResult>
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. args Arguments passed to this invoke. Arguments for getInstanceClusterBackupIamPolicy. options Invoke options controlling this call.
getInstanceIamPolicy(GetInstanceIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceIamPolicyResult>
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. args Arguments passed to this invoke. Arguments for getInstanceIamPolicy. options Invoke options controlling this call.
getInstanceTableIamPolicy(GetInstanceTableIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceTableIamPolicyResult>
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. args Arguments passed to this invoke. Arguments for getInstanceTableIamPolicy. options Invoke options controlling this call.
getTable(GetTableArgs args, {InvokeOptions? options}) → Future<GetTableResult>
Gets metadata information about the specified table. args Arguments passed to this invoke. Arguments for getTable. options Invoke options controlling this call.