googleapis
Version:
Google APIs Client Library for Node.js
938 lines (937 loc) • 500 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace bigtableadmin_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Bigtable Admin API
*
* Administer your Cloud Bigtable tables and instances.
*
* @example
* ```js
* const {google} = require('googleapis');
* const bigtableadmin = google.bigtableadmin('v2');
* ```
*/
export class Bigtableadmin {
context: APIRequestContext;
operations: Resource$Operations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
*/
export interface Schema$AppProfile {
/**
* Specifies that this app profile is intended for read-only usage via the Data Boost feature.
*/
dataBoostIsolationReadOnly?: Schema$DataBoostIsolationReadOnly;
/**
* Long form description of the use case for this AppProfile.
*/
description?: string | null;
/**
* Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
*/
etag?: string | null;
/**
* Use a multi-cluster routing policy.
*/
multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny;
/**
* The unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`.
*/
name?: string | null;
/**
* 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.
*/
priority?: string | null;
/**
* Use a single-cluster routing policy.
*/
singleClusterRouting?: Schema$SingleClusterRouting;
/**
* The standard options used for isolating this app profile's traffic from other use cases.
*/
standardIsolation?: Schema$StandardIsolation;
}
/**
* 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.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* 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.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* An Authorized View of a Cloud Bigtable Table.
*/
export interface Schema$AuthorizedView {
/**
* Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.
*/
deletionProtection?: boolean | null;
/**
* The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.
*/
etag?: string | null;
/**
* Identifier. The name of this AuthorizedView. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedViews/{authorized_view\}`
*/
name?: string | null;
/**
* An AuthorizedView permitting access to an explicit subset of a Table.
*/
subsetView?: Schema$GoogleBigtableAdminV2AuthorizedViewSubsetView;
}
/**
* Defines an automated backup policy for a table
*/
export interface Schema$AutomatedBackupPolicy {
/**
* How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.
*/
frequency?: string | null;
/**
* Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.
*/
retentionPeriod?: string | null;
}
/**
* Limits for the number of nodes a Cluster can autoscale up/down to.
*/
export interface Schema$AutoscalingLimits {
/**
* Required. Maximum number of nodes to scale up to.
*/
maxServeNodes?: number | null;
/**
* Required. Minimum number of nodes to scale down to.
*/
minServeNodes?: number | null;
}
/**
* The Autoscaling targets for a Cluster. These determine the recommended nodes.
*/
export interface Schema$AutoscalingTargets {
/**
* The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
*/
cpuUtilizationPercent?: number | null;
/**
* The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
*/
storageUtilizationGibPerNode?: number | null;
}
/**
* A backup of a Cloud Bigtable table.
*/
export interface Schema$Backup {
/**
* Indicates the backup type of the backup.
*/
backupType?: string | null;
/**
* Output only. The encryption information for the backup.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
*/
endTime?: string | null;
/**
* Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
*/
expireTime?: string | null;
/**
* The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
*/
hotToStandardTime?: string | null;
/**
* A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}`.
*/
name?: string | null;
/**
* Output only. Size of the backup in bytes.
*/
sizeBytes?: string | null;
/**
* Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/
*/
sourceBackup?: string | null;
/**
* Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project\}/instances/{instance\}/tables/{source_table\}`.
*/
sourceTable?: string | null;
/**
* Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
*/
startTime?: string | null;
/**
* Output only. The current state of the backup.
*/
state?: string | null;
}
/**
* Information about a backup.
*/
export interface Schema$BackupInfo {
/**
* Output only. Name of the backup.
*/
backup?: string | null;
/**
* Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
*/
endTime?: string | null;
/**
* Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/
*/
sourceBackup?: string | null;
/**
* Output only. Name of the table the backup was created from.
*/
sourceTable?: string | null;
/**
* Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
*/
startTime?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Change stream configuration.
*/
export interface Schema$ChangeStreamConfig {
/**
* How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
*/
retentionPeriod?: string | null;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
export interface Schema$CheckConsistencyRequest {
/**
* Required. The token created using GenerateConsistencyToken for the Table.
*/
consistencyToken?: string | null;
/**
* Checks that reads using an app profile with `DataBoostIsolationReadOnly` can see all writes committed before the token was created, but only if the read and write target the same cluster.
*/
dataBoostReadLocalWrites?: Schema$DataBoostReadLocalWrites;
/**
* Checks that reads using an app profile with `StandardIsolation` can see all writes committed before the token was created, even if the read and write target different clusters.
*/
standardReadRemoteWrites?: Schema$StandardReadRemoteWrites;
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
export interface Schema$CheckConsistencyResponse {
/**
* True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
*/
consistent?: boolean | null;
}
/**
* A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
*/
export interface Schema$Cluster {
/**
* Configuration for this cluster.
*/
clusterConfig?: Schema$ClusterConfig;
/**
* Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
*/
defaultStorageType?: string | null;
/**
* Immutable. The encryption configuration for CMEK-protected clusters.
*/
encryptionConfig?: Schema$EncryptionConfig;
/**
* Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project\}/locations/{zone\}`.
*/
location?: string | null;
/**
* The unique name of the cluster. Values are of the form `projects/{project\}/instances/{instance\}/clusters/a-z*`.
*/
name?: string | null;
/**
* Immutable. The node scaling factor of this cluster.
*/
nodeScalingFactor?: string | null;
/**
* The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
*/
serveNodes?: number | null;
/**
* Output only. The current state of the cluster.
*/
state?: string | null;
}
/**
* Autoscaling config for a cluster.
*/
export interface Schema$ClusterAutoscalingConfig {
/**
* Required. Autoscaling limits for this cluster.
*/
autoscalingLimits?: Schema$AutoscalingLimits;
/**
* Required. Autoscaling targets for this cluster.
*/
autoscalingTargets?: Schema$AutoscalingTargets;
}
/**
* Configuration for a cluster.
*/
export interface Schema$ClusterConfig {
/**
* Autoscaling configuration for this cluster.
*/
clusterAutoscalingConfig?: Schema$ClusterAutoscalingConfig;
}
/**
* The state of a table's data in a particular cluster.
*/
export interface Schema$ClusterState {
/**
* Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
*/
encryptionInfo?: Schema$EncryptionInfo[];
/**
* Output only. The state of replication for the table in this cluster.
*/
replicationState?: string | null;
}
/**
* A set of columns within a table which share a common configuration.
*/
export interface Schema$ColumnFamily {
/**
* Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
*/
gcRule?: Schema$GcRule;
/**
* Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above.
*/
stats?: Schema$ColumnFamilyStats;
/**
* The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
*/
valueType?: Schema$Type;
}
/**
* 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.
*/
export interface Schema$ColumnFamilyStats {
/**
* How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field.
*/
averageCellsPerColumn?: number | null;
/**
* How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
*/
averageColumnsPerRow?: number | null;
/**
* How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
*/
logicalDataBytes?: string | null;
}
/**
* Metadata type for the google.longrunning.Operation returned by CopyBackup.
*/
export interface Schema$CopyBackupMetadata {
/**
* The name of the backup being created through the copy operation. Values are of the form `projects//instances//clusters//backups/`.
*/
name?: string | null;
/**
* The progress of the CopyBackup operation.
*/
progress?: Schema$OperationProgress;
/**
* Information about the source backup that is being copied from.
*/
sourceBackupInfo?: Schema$BackupInfo;
}
/**
* The request for CopyBackup.
*/
export interface Schema$CopyBackupRequest {
/**
* Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent\}/backups/{backup_id\} to create the full backup name, of the form: `projects/{project\}/instances/{instance\}/clusters/{cluster\}/backups/{backup_id\}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
*/
backupId?: string | null;
/**
* Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
*/
expireTime?: string | null;
/**
* Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects//instances//clusters//backups/`.
*/
sourceBackup?: string | null;
}
/**
* The metadata for the Operation returned by CreateAuthorizedView.
*/
export interface Schema$CreateAuthorizedViewMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string | null;
/**
* The request that prompted the initiation of this CreateAuthorizedView operation.
*/
originalRequest?: Schema$CreateAuthorizedViewRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string | null;
}
/**
* The request for CreateAuthorizedView
*/
export interface Schema$CreateAuthorizedViewRequest {
/**
* Required. The AuthorizedView to create.
*/
authorizedView?: Schema$AuthorizedView;
/**
* Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedView/{authorized_view\}`.
*/
authorizedViewId?: string | null;
/**
* Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}`.
*/
parent?: string | null;
}
/**
* Metadata type for the operation returned by CreateBackup.
*/
export interface Schema$CreateBackupMetadata {
/**
* If set, the time at which this operation finished or was cancelled.
*/
endTime?: string | null;
/**
* The name of the backup being created.
*/
name?: string | null;
/**
* The name of the table the backup is created from.
*/
sourceTable?: string | null;
/**
* The time at which this operation started.
*/
startTime?: string | null;
}
/**
* The metadata for the Operation returned by CreateCluster.
*/
export interface Schema$CreateClusterMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string | null;
/**
* The request that prompted the initiation of this CreateCluster operation.
*/
originalRequest?: Schema$CreateClusterRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string | null;
/**
* Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects//instances//tables/`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far.
*/
tables?: {
[key: string]: Schema$TableProgress;
} | null;
}
/**
* Request message for BigtableInstanceAdmin.CreateCluster.
*/
export interface Schema$CreateClusterRequest {
/**
* Required. The cluster to be created. Fields marked `OutputOnly` must be left blank.
*/
cluster?: Schema$Cluster;
/**
* Required. The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
*/
clusterId?: string | null;
/**
* Required. The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project\}/instances/{instance\}`.
*/
parent?: string | null;
}
/**
* The metadata for the Operation returned by CreateInstance.
*/
export interface Schema$CreateInstanceMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string | null;
/**
* The request that prompted the initiation of this CreateInstance operation.
*/
originalRequest?: Schema$CreateInstanceRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string | null;
}
/**
* Request message for BigtableInstanceAdmin.CreateInstance.
*/
export interface Schema$CreateInstanceRequest {
/**
* Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank.
*/
clusters?: {
[key: string]: Schema$Cluster;
} | null;
/**
* Required. The instance to create. Fields marked `OutputOnly` must be left blank.
*/
instance?: Schema$Instance;
/**
* Required. The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
*/
instanceId?: string | null;
/**
* Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project\}`.
*/
parent?: string | null;
}
/**
* The metadata for the Operation returned by CreateLogicalView.
*/
export interface Schema$CreateLogicalViewMetadata {
/**
* If set, the time at which this operation finished or was canceled.
*/
endTime?: string | null;
/**
* The request that prompted the initiation of this CreateLogicalView operation.
*/
originalRequest?: Schema$CreateLogicalViewRequest;
/**
* The time at which this operation started.
*/
startTime?: string | null;
}
/**
* Request message for BigtableInstanceAdmin.CreateLogicalView.
*/
export interface Schema$CreateLogicalViewRequest {
/**
* Required. The logical view to create.
*/
logicalView?: Schema$LogicalView;
/**
* Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.
*/
logicalViewId?: string | null;
/**
* Required. The parent instance where this logical view will be created. Format: `projects/{project\}/instances/{instance\}`.
*/
parent?: string | null;
}
/**
* The metadata for the Operation returned by CreateMaterializedView.
*/
export interface Schema$CreateMaterializedViewMetadata {
/**
* If set, the time at which this operation finished or was canceled.
*/
endTime?: string | null;
/**
* The request that prompted the initiation of this CreateMaterializedView operation.
*/
originalRequest?: Schema$CreateMaterializedViewRequest;
/**
* The time at which this operation started.
*/
startTime?: string | null;
}
/**
* Request message for BigtableInstanceAdmin.CreateMaterializedView.
*/
export interface Schema$CreateMaterializedViewRequest {
/**
* Required. The materialized view to create.
*/
materializedView?: Schema$MaterializedView;
/**
* Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.
*/
materializedViewId?: string | null;
/**
* Required. The parent instance where this materialized view will be created. Format: `projects/{project\}/instances/{instance\}`.
*/
parent?: string | null;
}
/**
* The metadata for the Operation returned by CreateSchemaBundle.
*/
export interface Schema$CreateSchemaBundleMetadata {
/**
* If set, the time at which this operation finished or was canceled.
*/
endTime?: string | null;
/**
* The unique name identifying this schema bundle. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/schemaBundles/{schema_bundle\}`
*/
name?: string | null;
/**
* The time at which this operation started.
*/
startTime?: string | null;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
*/
export interface Schema$CreateTableRequest {
/**
* The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, `s1` and `s2`, three tablets will be created, spanning the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",` `"other", "zz"]` * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]` * Key assignment: - Tablet 1 `[, apple) =\> {"a"\}.` - Tablet 2 `[apple, customer_1) =\> {"apple", "custom"\}.` - Tablet 3 `[customer_1, customer_2) =\> {"customer_1"\}.` - Tablet 4 `[customer_2, other) =\> {"customer_2"\}.` - Tablet 5 `[other, ) =\> {"other", "zz"\}.`
*/
initialSplits?: Schema$Split[];
/**
* Required. The Table to create.
*/
table?: Schema$Table;
/**
* Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent\}/tables/foobar`. Maximum 50 characters.
*/
tableId?: string | null;
}
/**
* 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.
*/
export interface Schema$DataBoostIsolationReadOnly {
/**
* The Compute Billing Owner for this Data Boost App Profile.
*/
computeBillingOwner?: string | null;
}
/**
* Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.
*/
export interface Schema$DataBoostReadLocalWrites {
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
*/
export interface Schema$DropRowRangeRequest {
/**
* Delete all rows in the table. Setting this to false is a no-op.
*/
deleteAllDataFromTable?: boolean | null;
/**
* Delete all rows that start with this row key prefix. Prefix cannot be zero length.
*/
rowKeyPrefix?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
*/
export interface Schema$EncryptionConfig {
/**
* Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}`
*/
kmsKeyName?: string | null;
}
/**
* 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.
*/
export interface Schema$EncryptionInfo {
/**
* Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
*/
encryptionStatus?: Schema$Status;
/**
* Output only. The type of encryption used to protect this resource.
*/
encryptionType?: string | null;
/**
* Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
*/
kmsKeyVersion?: string | null;
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Rule for determining which cells to delete during garbage collection.
*/
export interface Schema$GcRule {
/**
* Delete cells that would be deleted by every nested rule.
*/
intersection?: Schema$Intersection;
/**
* Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
*/
maxAge?: string | null;
/**
* Delete all cells in a column except the most recent N.
*/
maxNumVersions?: number | null;
/**
* Delete cells that would be deleted by any nested rule.
*/
union?: Schema$Union;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
export interface Schema$GenerateConsistencyTokenRequest {
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
export interface Schema$GenerateConsistencyTokenResponse {
/**
* The generated consistency token.
*/
consistencyToken?: string | null;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* Subsets of a column family that are included in this AuthorizedView.
*/
export interface Schema$GoogleBigtableAdminV2AuthorizedViewFamilySubsets {
/**
* Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix ("").
*/
qualifierPrefixes?: string[] | null;
/**
* Individual exact column qualifiers to be included in the AuthorizedView.
*/
qualifiers?: string[] | null;
}
/**
* Defines a simple AuthorizedView that is a subset of the underlying Table.
*/
export interface Schema$GoogleBigtableAdminV2AuthorizedViewSubsetView {
/**
* Map from column family name to the columns in this family to be included in the AuthorizedView.
*/
familySubsets?: {
[key: string]: Schema$GoogleBigtableAdminV2AuthorizedViewFamilySubsets;
} | null;
/**
* Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix ("").
*/
rowPrefixes?: string[] | null;
}
/**
* 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` .
*/
export interface Schema$GoogleBigtableAdminV2TypeAggregate {
/**
* HyperLogLogPlusPlusUniqueCount aggregator.
*/
hllppUniqueCount?: Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount;
/**
* Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs.
*/
inputType?: Schema$Type;
/**
* Max aggregator.
*/
max?: Schema$GoogleBigtableAdminV2TypeAggregateMax;
/**
* Min aggregator.
*/
min?: Schema$GoogleBigtableAdminV2TypeAggregateMin;
/**
* Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen.
*/
stateType?: Schema$Type;
/**
* Sum aggregator.
*/
sum?: Schema$GoogleBigtableAdminV2TypeAggregateSum;
}
/**
* 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)
*/
export interface Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount {
}
/**
* Computes the max of the input values. Allowed input: `Int64` State: same as input
*/
export interface Schema$GoogleBigtableAdminV2TypeAggregateMax {
}
/**
* Computes the min of the input values. Allowed input: `Int64` State: same as input
*/
export interface Schema$GoogleBigtableAdminV2TypeAggregateMin {
}
/**
* Computes the sum of the input values. Allowed input: `Int64` State: same as input
*/
export interface Schema$GoogleBigtableAdminV2TypeAggregateSum {
}
/**
* An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`.
*/
export interface Schema$GoogleBigtableAdminV2TypeArray {
/**
* The type of the elements in the array. This must not be `Array`.
*/
elementType?: Schema$Type;
}
/**
* bool Values of type `Bool` are stored in `Value.bool_value`.
*/
export interface Schema$GoogleBigtableAdminV2TypeBool {
}
/**
* Bytes Values of type `Bytes` are stored in `Value.bytes_value`.
*/
export interface Schema$GoogleBigtableAdminV2TypeBytes {
/**
* The encoding to use when converting to or from lower level types.
*/
encoding?: Schema$GoogleBigtableAdminV2TypeBytesEncoding;
}
/**
* Rules used to convert to or from lower level types.
*/
export interface Schema$GoogleBigtableAdminV2TypeBytesEncoding {
/**
* Use `Raw` encoding.