googleapis
Version:
Google APIs Client Library for Node.js
988 lines (987 loc) • 107 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace bigtableadmin_v2 {
interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* 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
* const {google} = require('googleapis');
* const bigtableadmin = google.bigtableadmin('v2');
*
* @namespace bigtableadmin
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Bigtableadmin
*/
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.
*/
interface Schema$AppProfile {
/**
* Optional long form description of the use case for this AppProfile.
*/
description?: string;
/**
* 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;
/**
* Use a multi-cluster routing policy.
*/
multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny;
/**
* (`OutputOnly`) The unique name of the app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
*/
name?: string;
/**
* 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
*/
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;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
*/
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[];
/**
* The log type that this config enables.
*/
logType?: string;
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
*/
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@gmail.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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
interface Schema$CheckConsistencyRequest {
/**
* The token created using GenerateConsistencyToken for the Table.
*/
consistencyToken?: string;
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
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;
}
/**
* A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
*/
interface Schema$Cluster {
/**
* (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
*/
defaultStorageType?: string;
/**
* (`CreationOnly`) 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;
/**
* (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`.
*/
name?: string;
/**
* The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
*/
serveNodes?: number;
/**
* (`OutputOnly`) The current state of the cluster.
*/
state?: string;
}
/**
* The state of a table's data in a particular cluster.
*/
interface Schema$ClusterState {
/**
* Output only. The state of replication for the table in this cluster.
*/
replicationState?: string;
}
/**
* A set of columns within a table which share a common configuration.
*/
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;
}
/**
* The metadata for the Operation returned by CreateCluster.
*/
interface Schema$CreateClusterMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this CreateCluster operation.
*/
originalRequest?: Schema$CreateClusterRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
/**
* Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. 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;
};
}
/**
* Request message for BigtableInstanceAdmin.CreateCluster.
*/
interface Schema$CreateClusterRequest {
/**
* The cluster to be created. Fields marked `OutputOnly` must be left blank.
*/
cluster?: Schema$Cluster;
/**
* 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;
/**
* The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`.
*/
parent?: string;
}
/**
* The metadata for the Operation returned by CreateInstance.
*/
interface Schema$CreateInstanceMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this CreateInstance operation.
*/
originalRequest?: Schema$CreateInstanceRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
/**
* Request message for BigtableInstanceAdmin.CreateInstance.
*/
interface Schema$CreateInstanceRequest {
/**
* 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 two clusters can be specified.
*/
clusters?: {
[key: string]: Schema$Cluster;
};
/**
* The instance to create. Fields marked `OutputOnly` must be left blank.
*/
instance?: Schema$Instance;
/**
* 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;
/**
* The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`.
*/
parent?: string;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
*/
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[];
/**
* The Table to create.
*/
table?: Schema$Table;
/**
* 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;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
*/
interface Schema$DropRowRangeRequest {
/**
* Delete all rows in the table. Setting this to false is a no-op.
*/
deleteAllDataFromTable?: boolean;
/**
* Delete all rows that start with this row key prefix. Prefix cannot be zero length.
*/
rowKeyPrefix?: string;
}
/**
* 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 `{}`.
*/
interface Schema$Empty {
}
/**
* Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
*/
interface Schema$Expr {
/**
* An 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;
/**
* Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
*/
expression?: string;
/**
* An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
* An 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;
}
/**
* Rule for determining which cells to delete during garbage collection.
*/
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;
/**
* Delete all cells in a column except the most recent N.
*/
maxNumVersions?: number;
/**
* Delete cells that would be deleted by any nested rule.
*/
union?: Schema$Union;
}
/**
* Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
interface Schema$GenerateConsistencyTokenRequest {
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
interface Schema$GenerateConsistencyTokenResponse {
/**
* The generated consistency token.
*/
consistencyToken?: string;
}
/**
* Request message for `GetIamPolicy` method.
*/
interface Schema$GetIamPolicyRequest {
}
/**
* A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
*/
interface Schema$Instance {
/**
* 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;
/**
* 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;
};
/**
* (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`.
*/
name?: string;
/**
* (`OutputOnly`) The current state of the instance.
*/
state?: string;
/**
* The type of the instance. Defaults to `PRODUCTION`.
*/
type?: string;
}
/**
* A GcRule which deletes cells matching all of the given rules.
*/
interface Schema$Intersection {
/**
* Only delete cells which would be deleted by every element of `rules`.
*/
rules?: Schema$GcRule[];
}
/**
* Response message for BigtableInstanceAdmin.ListAppProfiles.
*/
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/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
* 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;
}
/**
* Response message for BigtableInstanceAdmin.ListClusters.
*/
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/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
* DEPRECATED: This field is unused and ignored.
*/
nextPageToken?: string;
}
/**
* Response message for BigtableInstanceAdmin.ListInstances.
*/
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/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
* The list of requested instances.
*/
instances?: Schema$Instance[];
/**
* DEPRECATED: This field is unused and ignored.
*/
nextPageToken?: string;
}
/**
* The response message for Locations.ListLocations.
*/
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;
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
*/
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;
/**
* The tables present in the requested instance.
*/
tables?: Schema$Table[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
};
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
};
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
/**
* A create, update, or delete of a particular column family.
*/
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;
/**
* The ID of the column family to be modified.
*/
id?: string;
/**
* 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
*/
interface Schema$ModifyColumnFamiliesRequest {
/**
* 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.
*/
interface Schema$MultiClusterRoutingUseAny {
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
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;
/**
* 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;
};
/**
* 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;
/**
* 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;
};
}
/**
* Request message for BigtableInstanceAdmin.PartialUpdateInstance.
*/
interface Schema$PartialUpdateInstanceRequest {
/**
* The Instance which will (partially) replace the current value.
*/
instance?: Schema$Instance;
/**
* The subset of Instance fields which should be replaced. Must be explicitly set.
*/
updateMask?: string;
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
*/
interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
*/
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. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
*/
etag?: string;
/**
* Deprecated.
*/
version?: number;
}
/**
* Request message for `SetIamPolicy` method.
*/
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" This field is only used by Cloud IAM.
*/
updateMask?: string;
}
/**
* Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
*/
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;
/**
* The cluster to which read/write requests should be routed.
*/
clusterId?: string;
}
/**
* An initial split point for a newly created table.
*/
interface Schema$Split {
/**
* Row key to use as an initial tablet boundary.
*/
key?: string;
}
/**
* 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).
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* 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;
}>;
/**
* 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;
}
/**
* A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
*/
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`, `FULL`
*/
clusterStates?: {
[key: string]: Schema$ClusterState;
};
/**
* (`CreationOnly`) The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
*/
columnFamilies?: {
[key: string]: Schema$ColumnFamily;
};
/**
* (`CreationOnly`) 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;
/**
* Output only. 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;
}
/**
* Progress info for copying a table's data to the new cluster.
*/
interface Schema$TableProgress {
/**
* Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED.
*/
estimatedCopiedBytes?: string;
/**
* Estimate of the size of the table to be copied.
*/
estimatedSizeBytes?: string;
state?: string;
}
/**
* Request message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
/**
* Response message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[];
}
/**
* A GcRule which deletes cells matching any of the given rules.
*/
interface Schema$Union {
/**
* Delete cells which would be deleted by any element of `rules`.
*/
rules?: Schema$GcRule[];
}
/**
* The metadata for the Operation returned by UpdateAppProfile.
*/
interface Schema$UpdateAppProfileMetadata {
}
/**
* The metadata for the Operation returned by UpdateCluster.
*/
interface Schema$UpdateClusterMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this UpdateCluster operation.
*/
originalRequest?: Schema$Cluster;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
/**
* The metadata for the Operation returned by UpdateInstance.
*/
interface Schema$UpdateInstanceMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this UpdateInstance operation.
*/
originalRequest?: Schema$PartialUpdateInstanceRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
class Resource$Operations {
context: APIRequestContext;
projects: Resource$Operations$Projects;
constructor(context: APIRequestContext);
/**
* bigtableadmin.operations.cancel
* @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @alias bigtableadmin.operations.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be cancelled.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigtableadmin.operations.delete
* @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @alias bigtableadmin.operations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigtableadmin.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias bigtableadmin.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Operations$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
}
interface Params$Resource$Operations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
class Resource$Operations$Projects {
context: APIRequestContext;
operations: Resource$Operations$Projects$Operations;
constructor(context: APIRequestContext);
}
class Resource$Operations$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigtableadmin.operations.projects.operations.list
* @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias bigtableadmin.operations.projects.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The name of the operation's parent resource.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Operations$Projects$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Operations$Projects$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Operations$Projects$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
interface Params$Resource$Operations$Projects$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
class Resource$Projects {
context: APIRequestContext;
instances: Resource$Projects$Instances;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
class Resource$Projects$Instances {
context: APIRequestContext;
appProfiles: Resource$Projects$Instances$Appprofiles;
clusters: Resource$Projects$Instances$Clusters;
tables: Resource$Projects$Instances$Tables;
constructor(context: APIRequestContext);
/**
* bigtableadmin.projects.instances.create
* @desc Create an instance within a project.
* @alias bigtableadmin.projects.instances.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`.
* @param {().CreateInstanceRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Instances$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Instances$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Instances$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* bigtableadmin.projects.instances.delete
* @desc Delete an instance from a project.
* @alias bigtableadmin.projects.instances.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The unique name of the instance to be deleted. Values are of the form `projects/<project>/instances/<instance>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Instances$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Instances$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* bigtableadmin.projects.instances.get
* @desc Gets information about an instance.