googleapis
Version:
Google APIs Client Library for Node.js
949 lines • 252 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, 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 {
/**
* 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. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`.
*/
name?: string | null;
/**
* Use a single-cluster routing policy.
*/
singleClusterRouting?: Schema$SingleClusterRouting;
}
/**
* 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;
}
/**
* A backup of a Cloud Bigtable table.
*/
export interface Schema$Backup {
/**
* 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, with microseconds 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;
/**
* 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;
/**
* 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 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` 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 members 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 identities requesting access for a Cloud Platform 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. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[] | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: 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;
}
/**
* 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 {
/**
* 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;
/**
* Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
*/
serveNodes?: number | null;
/**
* Output only. The current state of the cluster.
*/
state?: string | null;
}
/**
* 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;
}
/**
* 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. Currently, at most four clusters can be specified.
*/
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;
}
/**
* 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;
}
/**
* 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); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
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. 3) All clusters within an instance must use the same CMEK key. 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;
}
/**
* Added to the error payload.
*/
export interface Schema$FailureTrace {
frames?: Schema$Frame[];
}
export interface Schema$Frame {
targetName?: string | null;
workflowGuid?: string | null;
zoneId?: 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 policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. 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;
}
/**
* A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
*/
export interface Schema$Instance {
/**
* Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
*/
displayName?: string | null;
/**
* Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll\}\p{Lo\}{0,62\}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll\}\p{Lo\}\p{N\}_-]{0,63\}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The unique name of the instance. Values are of the form `projects/{project\}/instances/a-z+[a-z0-9]`.
*/
name?: string | null;
/**
* Output only. The current state of the instance.
*/
state?: string | null;
/**
* Required. The type of the instance. Defaults to `PRODUCTION`.
*/
type?: string | null;
}
/**
* A GcRule which deletes cells matching all of the given rules.
*/
export interface Schema$Intersection {
/**
* Only delete cells which would be deleted by every element of `rules`.
*/
rules?: Schema$GcRule[];
}
/**
* Response message for BigtableInstanceAdmin.ListAppProfiles.
*/
export interface Schema$ListAppProfilesResponse {
/**
* The list of requested app profiles.
*/
appProfiles?: Schema$AppProfile[];
/**
* Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles`. Values are of the form `projects//locations/`
*/
failedLocations?: string[] | null;
/**
* Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
*/
nextPageToken?: string | null;
}
/**
* The response for ListBackups.
*/
export interface Schema$ListBackupsResponse {
/**
* The list of matching backups.
*/
backups?: Schema$Backup[];
/**
* `next_page_token` can be sent in a subsequent ListBackups call to fetch more of the matching backups.
*/
nextPageToken?: string | null;
}
/**
* Response message for BigtableInstanceAdmin.ListClusters.
*/
export interface Schema$ListClustersResponse {
/**
* The list of requested clusters.
*/
clusters?: Schema$Cluster[];
/**
* Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters`, or may only have partial information returned. Values are of the form `projects//locations/`
*/
failedLocations?: string[] | null;
/**
* DEPRECATED: This field is unused and ignored.
*/
nextPageToken?: string | null;
}
/**
* Response message for BigtableInstanceAdmin.ListInstances.
*/
export interface Schema$ListInstancesResponse {
/**
* Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects//locations/`
*/
failedLocations?: string[] | null;
/**
* The list of requested instances.
*/
instances?: Schema$Instance[];
/**
* DEPRECATED: This field is unused and ignored.
*/
nextPageToken?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
*/
export interface Schema$ListTablesResponse {
/**
* Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
*/
nextPageToken?: string | null;
/**
* The tables present in the requested instance.
*/
tables?: Schema$Table[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* A create, update, or delete of a particular column family.
*/
export interface Schema$Modification {
/**
* Create a new column family with the specified schema, or fail if one already exists with the given ID.
*/
create?: Schema$ColumnFamily;
/**
* Drop (delete) the column family with the given ID, or fail if no such family exists.
*/
drop?: boolean | null;
/**
* The ID of the column family to be modified.
*/
id?: string | null;
/**
* Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
*/
update?: Schema$ColumnFamily;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
*/
export interface Schema$ModifyColumnFamiliesRequest {
/**
* Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).
*/
modifications?: Schema$Modification[];
}
/**
* 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.
*/
export interface Schema$MultiClusterRoutingUseAny {
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Encapsulates progress related information for a Cloud Bigtable long running operation.
*/
export interface Schema$OperationProgress {
/**
* If set, the time at which this operation failed or was completed successfully.
*/
endTime?: string | null;
/**
* Percent completion of the operation. Values are between 0 and 100 inclusive.
*/
progressPercent?: number | null;
/**
* Time the request was received.
*/
startTime?: string | null;
}
/**
* 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.
*/
export interface Schema$OptimizeRestoredTableMetadata {
/**
* Name of the restored table being optimized.
*/
name?: string | null;
/**
* The progress of the post-restore optimizations.
*/
progress?: Schema$OperationProgress;
}
/**
* Request message for BigtableInstanceAdmin.PartialUpdateInstance.
*/
export interface Schema$PartialUpdateInstanceRequest {
/**
* Required. The Instance which will (partially) replace the current value.
*/
instance?: Schema$Instance;
/**
* Required. The subset of Instance fields which should be replaced. Must be explicitly set.
*/
updateMask?: string | null;
}
/**
* 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* Information about a table restore.
*/
export interface Schema$RestoreInfo {
/**
* Information about the backup used to restore the table. The backup may no longer exist.
*/
backupInfo?: Schema$BackupInfo;
/**
* The type of the restore source.
*/
sourceType?: string | null;
}
/**
* Metadata type for the long-running operation returned by RestoreTable.
*/
export interface Schema$RestoreTableMetadata {
backupInfo?: Schema$BackupInfo;
/**
* Name of the table being created and restored to.
*/
name?: string | null;
/**
* If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored table. The metadata type of the long-running operation is OptimizeRestoreTableMetadata. The response type is Empty. This long-running operation may be automatically created by the system if applicable after the RestoreTable long-running operation completes successfully. This operation may not be created if the table is already optimized or the restore was not successful.
*/
optimizeTableOperationName?: string | null;
/**
* The progress of the RestoreTable operation.
*/
progress?: Schema$OperationProgress;
/**
* The type of the restore source.
*/
sourceType?: string | null;
}
/**
* The request for RestoreTable.
*/
export interface Schema$RestoreTableRequest {
/**
* Name of the backup from which to restore. Values are of the form `projects//instances//clusters//backups/`.
*/
backup?: string | null;
/**
* Required. The id of the table to create and restore to. This table must not already exist. The `table_id` appended to `parent` forms the full table name of the form `projects//instances//tables/`.
*/
tableId?: string | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*/
updateMask?: string | null;
}
/**
* Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
*/
export interface Schema$SingleClusterRouting {
/**
* Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
*/
allowTransactionalWrites?: boolean | null;
/**
* The cluster to which read/write requests should be routed.
*/
clusterId?: string | null;
}
/**
* An initial split point for a newly created table.
*/
export interface Schema$Split {
/**
* Row key to use as an initial tablet boundary.
*/
key?: string | null;
}
/**
* 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](https://github.com/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](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
*/
export interface Schema$Table {
/**
* Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
*/
clusterStates?: {
[key: string]: Schema$ClusterState;
} | null;
/**
* The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
*/
columnFamilies?: {
[key: string]: Schema$ColumnFamily;
} | null;
/**
* 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`.
*/
granularity?: string | null;
/**
* The unique name of the table. Values are of the form `projects/{project\}/instances/{instance\}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
*/
name?: string | null;
/**
* Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
*/
restoreInfo?: Schema$RestoreInfo;
}
/**
* Progress info for copying a table's data to the new cluster.
*/
export interface Schema$TableProgress {
/**
* Estimate of the number of bytes copied so far for this ta