google-apis-rs/google_bigtableadmin2_cli/build_html/search/search_index.json

{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"The bigtableadmin2 command-line interface (CLI) allows to use most features of the Google Bigtable Admin service from the comfort of your terminal. By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero. If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools. Everything else about the Bigtable Admin API can be found at the official documentation site . Installation and Source Code Install the command-line interface with cargo using: cargo install google-bigtableadmin2-cli Find the source code on github . Usage This documentation was generated from the Bigtable Admin API at revision 20240221 . The CLI is at version 5.0.4 . bigtableadmin2 [options] operations get <name> [-p <v>]... [-o <out>] projects-operations-list <name> [-p <v>]... [-o <out>] projects instances-app-profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-app-profiles-delete <name> [-p <v>]... [-o <out>] instances-app-profiles-get <name> [-p <v>]... [-o <out>] instances-app-profiles-list <parent> [-p <v>]... [-o <out>] instances-app-profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-copy <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-delete <name> [-p <v>]... [-o <out>] instances-clusters-backups-get <name> [-p <v>]... [-o <out>] instances-clusters-backups-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-list <parent> [-p <v>]... [-o <out>] instances-clusters-backups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-delete <name> [-p <v>]... [-o <out>] instances-clusters-get <name> [-p <v>]... [-o <out>] instances-clusters-hot-tablets-list <parent> [-p <v>]... [-o <out>] instances-clusters-list <parent> [-p <v>]... [-o <out>] instances-clusters-partial-update-cluster <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-update <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-delete <name> [-p <v>]... [-o <out>] instances-get <name> [-p <v>]... [-o <out>] instances-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-list <parent> [-p <v>]... [-o <out>] instances-partial-update-instance <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-check-consistency <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-delete <name> [-p <v>]... [-o <out>] instances-tables-drop-row-range <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-generate-consistency-token <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-get <name> [-p <v>]... [-o <out>] instances-tables-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-list <parent> [-p <v>]... [-o <out>] instances-tables-modify-column-families <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-restore <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-undelete <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-update <name> (-r <kv>)... [-p <v>]... [-o <out>] locations-list <name> [-p <v>]... [-o <out>] bigtableadmin2 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli] Configuration The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with bigtableadmin2- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs. Authentication Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/bigtableadmin2-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation . Application Secrets In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/bigtableadmin2-secret.json , assuming that the required bigtableadmin API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation . Debugging Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. bigtableadmin2 --debug <resource> <method> [options] 2>debug.txt .","title":"Home"},{"location":"#installation-and-source-code","text":"Install the command-line interface with cargo using: cargo install google-bigtableadmin2-cli Find the source code on github .","title":"Installation and Source Code"},{"location":"#usage","text":"This documentation was generated from the Bigtable Admin API at revision 20240221 . The CLI is at version 5.0.4 . bigtableadmin2 [options] operations get <name> [-p <v>]... [-o <out>] projects-operations-list <name> [-p <v>]... [-o <out>] projects instances-app-profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-app-profiles-delete <name> [-p <v>]... [-o <out>] instances-app-profiles-get <name> [-p <v>]... [-o <out>] instances-app-profiles-list <parent> [-p <v>]... [-o <out>] instances-app-profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-copy <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-delete <name> [-p <v>]... [-o <out>] instances-clusters-backups-get <name> [-p <v>]... [-o <out>] instances-clusters-backups-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-list <parent> [-p <v>]... [-o <out>] instances-clusters-backups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-backups-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-delete <name> [-p <v>]... [-o <out>] instances-clusters-get <name> [-p <v>]... [-o <out>] instances-clusters-hot-tablets-list <parent> [-p <v>]... [-o <out>] instances-clusters-list <parent> [-p <v>]... [-o <out>] instances-clusters-partial-update-cluster <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-clusters-update <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-delete <name> [-p <v>]... [-o <out>] instances-get <name> [-p <v>]... [-o <out>] instances-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-list <parent> [-p <v>]... [-o <out>] instances-partial-update-instance <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-check-consistency <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-create <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-delete <name> [-p <v>]... [-o <out>] instances-tables-drop-row-range <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-generate-consistency-token <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-get <name> [-p <v>]... [-o <out>] instances-tables-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-list <parent> [-p <v>]... [-o <out>] instances-tables-modify-column-families <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-patch <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-restore <parent> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-tables-undelete <name> (-r <kv>)... [-p <v>]... [-o <out>] instances-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>] instances-update <name> (-r <kv>)... [-p <v>]... [-o <out>] locations-list <name> [-p <v>]... [-o <out>] bigtableadmin2 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli]","title":"Usage"},{"location":"#configuration","text":"The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with bigtableadmin2- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs.","title":"Configuration"},{"location":"#authentication","text":"Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/bigtableadmin2-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation .","title":"Authentication"},{"location":"#application-secrets","text":"In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/bigtableadmin2-secret.json , assuming that the required bigtableadmin API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation .","title":"Application Secrets"},{"location":"#debugging","text":"Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. bigtableadmin2 --debug <resource> <method> [options] 2>debug.txt .","title":"Debugging"},{"location":"operations_get/","text":"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. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> operations get ... Required Scalar Argument <name> (string) The name of the operation resource. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get"},{"location":"operations_get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> operations get ...","title":"Scopes"},{"location":"operations_get/#required-scalar-argument","text":"<name> (string) The name of the operation resource.","title":"Required Scalar Argument"},{"location":"operations_get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"operations_get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"operations_projects-operations-list/","text":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED . Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> operations projects-operations-list ... Required Scalar Argument <name> (string) The name of the operation's parent resource. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string The standard list filter. -p page-size=integer The standard list page size. -p page-token=string The standard list page token. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Projects Operations List"},{"location":"operations_projects-operations-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> operations projects-operations-list ...","title":"Scopes"},{"location":"operations_projects-operations-list/#required-scalar-argument","text":"<name> (string) The name of the operation's parent resource.","title":"Required Scalar Argument"},{"location":"operations_projects-operations-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"operations_projects-operations-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string The standard list filter. -p page-size=integer The standard list page size. -p page-token=string The standard list page token.","title":"Optional Method Properties"},{"location":"operations_projects-operations-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-app-profiles-create/","text":"Creates an app profile within an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-create ... Required Scalar Argument <parent> (string) Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: AppProfile: description: string etag: string multi-cluster-routing-use-any: cluster-ids: [string] name: string priority: string single-cluster-routing: allow-transactional-writes: boolean cluster-id: string standard-isolation: priority: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=et Long form description of the use case for this AppProfile. etag=magna 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 and RFC 7232 for more details. multi-cluster-routing-use-any cluster-ids=no The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. Each invocation of this argument appends the given value to the array. .. name=ipsum The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* . priority=voluptua. 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. single-cluster-routing allow-transactional-writes=false 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. cluster-id=amet. The cluster to which read/write requests should be routed. ..standard-isolation priority=takimata The priority of requests sent using this app profile. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p app-profile-id=string Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile . -p ignore-warnings=boolean If true, ignore safety checks when creating the app profile. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances App Profiles Create"},{"location":"projects_instances-app-profiles-create/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-create ...","title":"Scopes"},{"location":"projects_instances-app-profiles-create/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-app-profiles-create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: AppProfile: description: string etag: string multi-cluster-routing-use-any: cluster-ids: [string] name: string priority: string single-cluster-routing: allow-transactional-writes: boolean cluster-id: string standard-isolation: priority: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=et Long form description of the use case for this AppProfile. etag=magna 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 and RFC 7232 for more details. multi-cluster-routing-use-any cluster-ids=no The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. Each invocation of this argument appends the given value to the array. .. name=ipsum The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* . priority=voluptua. 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. single-cluster-routing allow-transactional-writes=false 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. cluster-id=amet. The cluster to which read/write requests should be routed. ..standard-isolation priority=takimata The priority of requests sent using this app profile.","title":"Required Request Value"},{"location":"projects_instances-app-profiles-create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-app-profiles-create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-app-profiles-create/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p app-profile-id=string Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile . -p ignore-warnings=boolean If true, ignore safety checks when creating the app profile.","title":"Optional Method Properties"},{"location":"projects_instances-app-profiles-create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-app-profiles-delete/","text":"Deletes an app profile from an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-delete ... Required Scalar Argument <name> (string) Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p ignore-warnings=boolean Required. If true, ignore safety checks when deleting the app profile. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances App Profiles Delete"},{"location":"projects_instances-app-profiles-delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-delete ...","title":"Scopes"},{"location":"projects_instances-app-profiles-delete/#required-scalar-argument","text":"<name> (string) Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} .","title":"Required Scalar Argument"},{"location":"projects_instances-app-profiles-delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-app-profiles-delete/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p ignore-warnings=boolean Required. If true, ignore safety checks when deleting the app profile.","title":"Optional Method Properties"},{"location":"projects_instances-app-profiles-delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-app-profiles-get/","text":"Gets information about an app profile. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-get ... Required Scalar Argument <name> (string) Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances App Profiles Get"},{"location":"projects_instances-app-profiles-get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-get ...","title":"Scopes"},{"location":"projects_instances-app-profiles-get/#required-scalar-argument","text":"<name> (string) Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile} .","title":"Required Scalar Argument"},{"location":"projects_instances-app-profiles-get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-app-profiles-get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-app-profiles-list/","text":"Lists information about app profiles in an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-list ... Required Scalar Argument <parent> (string) Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = &#39;-&#39; to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/- . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-size=integer Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances App Profiles List"},{"location":"projects_instances-app-profiles-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-list ...","title":"Scopes"},{"location":"projects_instances-app-profiles-list/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = &#39;-&#39; to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/- .","title":"Required Scalar Argument"},{"location":"projects_instances-app-profiles-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-app-profiles-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-size=integer Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call.","title":"Optional Method Properties"},{"location":"projects_instances-app-profiles-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-app-profiles-patch/","text":"Updates an app profile within an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-patch ... Required Scalar Argument <name> (string) The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: AppProfile: description: string etag: string multi-cluster-routing-use-any: cluster-ids: [string] name: string priority: string single-cluster-routing: allow-transactional-writes: boolean cluster-id: string standard-isolation: priority: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=amet. Long form description of the use case for this AppProfile. etag=duo 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 and RFC 7232 for more details. multi-cluster-routing-use-any cluster-ids=ipsum The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. Each invocation of this argument appends the given value to the array. .. name=gubergren The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* . priority=lorem 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. single-cluster-routing allow-transactional-writes=false 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. cluster-id=dolor The cluster to which read/write requests should be routed. ..standard-isolation priority=ea The priority of requests sent using this app profile. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p ignore-warnings=boolean If true, ignore safety checks when updating the app profile. -p update-mask=string Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances App Profiles Patch"},{"location":"projects_instances-app-profiles-patch/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-app-profiles-patch ...","title":"Scopes"},{"location":"projects_instances-app-profiles-patch/#required-scalar-argument","text":"<name> (string) The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* .","title":"Required Scalar Argument"},{"location":"projects_instances-app-profiles-patch/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: AppProfile: description: string etag: string multi-cluster-routing-use-any: cluster-ids: [string] name: string priority: string single-cluster-routing: allow-transactional-writes: boolean cluster-id: string standard-isolation: priority: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . description=amet. Long form description of the use case for this AppProfile. etag=duo 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 and RFC 7232 for more details. multi-cluster-routing-use-any cluster-ids=ipsum The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. Each invocation of this argument appends the given value to the array. .. name=gubergren The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9* . priority=lorem 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. single-cluster-routing allow-transactional-writes=false 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. cluster-id=dolor The cluster to which read/write requests should be routed. ..standard-isolation priority=ea The priority of requests sent using this app profile.","title":"Required Request Value"},{"location":"projects_instances-app-profiles-patch/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-app-profiles-patch/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-app-profiles-patch/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p ignore-warnings=boolean If true, ignore safety checks when updating the app profile. -p update-mask=string Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.","title":"Optional Method Properties"},{"location":"projects_instances-app-profiles-patch/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-copy/","text":"Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-copy ... Required Scalar Argument <parent> (string) Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CopyBackupRequest: backup-id: string expire-time: string source-backup: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backup-id=ipsum 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*. expire-time=invidunt 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. source-backup=amet 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/ . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Copy"},{"location":"projects_instances-clusters-backups-copy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-copy ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-copy/#required-scalar-argument","text":"<parent> (string) Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-copy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CopyBackupRequest: backup-id: string expire-time: string source-backup: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backup-id=ipsum 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*. expire-time=invidunt 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. source-backup=amet 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/ .","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-copy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-copy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-copy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-create/","text":"Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-create ... Required Scalar Argument <parent> (string) Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Backup: encryption-info: encryption-status: code: integer message: string encryption-type: string kms-key-version: string end-time: string expire-time: string name: string size-bytes: string source-backup: string source-table: string start-time: string state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .encryption-info.encryption-status code=81 The status code, which should be an enum value of google.rpc.Code. message=ipsum 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. .. encryption-type=sed Output only. The type of encryption used to protect this resource. kms-key-version=ut Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. .. end-time=gubergren 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. expire-time=rebum. Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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. name=est 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} . size-bytes=ipsum Output only. Size of the backup in bytes. source-backup=ipsum 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/ source-table=est 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} . start-time=gubergren 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. state=ea Output only. The current state of the backup. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p backup-id=string Required. The id of the backup to be created. The backup_id along with the parent 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*. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Create"},{"location":"projects_instances-clusters-backups-create/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-create ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-create/#required-scalar-argument","text":"<parent> (string) Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Backup: encryption-info: encryption-status: code: integer message: string encryption-type: string kms-key-version: string end-time: string expire-time: string name: string size-bytes: string source-backup: string source-table: string start-time: string state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .encryption-info.encryption-status code=81 The status code, which should be an enum value of google.rpc.Code. message=ipsum 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. .. encryption-type=sed Output only. The type of encryption used to protect this resource. kms-key-version=ut Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. .. end-time=gubergren 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. expire-time=rebum. Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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. name=est 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} . size-bytes=ipsum Output only. Size of the backup in bytes. source-backup=ipsum 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/ source-table=est 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} . start-time=gubergren 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. state=ea Output only. The current state of the backup.","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-create/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p backup-id=string Required. The id of the backup to be created. The backup_id along with the parent 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*.","title":"Optional Method Properties"},{"location":"projects_instances-clusters-backups-create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-delete/","text":"Deletes a pending or completed Cloud Bigtable backup. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-delete ... Required Scalar Argument <name> (string) Required. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Delete"},{"location":"projects_instances-clusters-backups-delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-delete ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-delete/#required-scalar-argument","text":"<name> (string) Required. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-get-iam-policy/","text":"Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-get-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=2 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 . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Get Iam Policy"},{"location":"projects_instances-clusters-backups-get-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-get-iam-policy ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-get-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-get-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=2 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 .","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-get-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-get-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-get-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-get/","text":"Gets metadata on a pending or completed Cloud Bigtable Backup. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-get ... Required Scalar Argument <name> (string) Required. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Get"},{"location":"projects_instances-clusters-backups-get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-get ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-get/#required-scalar-argument","text":"<name> (string) Required. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-list/","text":"Lists Cloud Bigtable backups. Returns both completed and pending backups. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-list ... Required Scalar Argument <parent> (string) Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Use {cluster} = &#39;-&#39; to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/- . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * name * source_table * state * start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * end_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * size_bytes To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * name:&#34;exact&#34; --> The backup's name is the string \"exact\". * name:howl --> The backup's name contains the string \"howl\". * source_table:prod --> The source_table's name contains the string \"prod\". * state:CREATING --> The backup is pending creation. * state:READY --> The backup is fully created and ready for use. * (name:howl) AND (start_time &lt; \\&#34;2018-03-28T14:50:00Z\\&#34;) --> The backup name contains the string \"howl\" and start_time of the backup is before 2018-03-28T14:50:00Z. * size_bytes &gt; 10000000000 --> The backup's size is greater than 10GB -p order-by=string An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, \"start_time\". The default sorting order is ascending. To specify descending order for the field, a suffix \" desc\" should be appended to the field name. For example, \"start_time desc\". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup. -p page-size=integer Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. -p page-token=string If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter . Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups List"},{"location":"projects_instances-clusters-backups-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-list ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-list/#required-scalar-argument","text":"<parent> (string) Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Use {cluster} = &#39;-&#39; to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/- .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * name * source_table * state * start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * end_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * size_bytes To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * name:&#34;exact&#34; --> The backup's name is the string \"exact\". * name:howl --> The backup's name contains the string \"howl\". * source_table:prod --> The source_table's name contains the string \"prod\". * state:CREATING --> The backup is pending creation. * state:READY --> The backup is fully created and ready for use. * (name:howl) AND (start_time &lt; \\&#34;2018-03-28T14:50:00Z\\&#34;) --> The backup name contains the string \"howl\" and start_time of the backup is before 2018-03-28T14:50:00Z. * size_bytes &gt; 10000000000 --> The backup's size is greater than 10GB -p order-by=string An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, \"start_time\". The default sorting order is ascending. To specify descending order for the field, a suffix \" desc\" should be appended to the field name. For example, \"start_time desc\". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup. -p page-size=integer Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. -p page-token=string If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter .","title":"Optional Method Properties"},{"location":"projects_instances-clusters-backups-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-patch/","text":"Updates a pending or completed Cloud Bigtable Backup. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-patch ... Required Scalar Argument <name> (string) 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} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Backup: encryption-info: encryption-status: code: integer message: string encryption-type: string kms-key-version: string end-time: string expire-time: string name: string size-bytes: string source-backup: string source-table: string start-time: string state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .encryption-info.encryption-status code=45 The status code, which should be an enum value of google.rpc.Code. message=eos 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. .. encryption-type=labore Output only. The type of encryption used to protect this resource. kms-key-version=sed Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. .. end-time=duo 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. expire-time=sed Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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. name=no 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} . size-bytes=stet Output only. Size of the backup in bytes. source-backup=kasd 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/ source-table=et 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} . start-time=sed 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. state=et Output only. The current state of the backup. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. A mask specifying which fields (e.g. expire_time ) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Patch"},{"location":"projects_instances-clusters-backups-patch/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-patch ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-patch/#required-scalar-argument","text":"<name> (string) 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} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-patch/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Backup: encryption-info: encryption-status: code: integer message: string encryption-type: string kms-key-version: string end-time: string expire-time: string name: string size-bytes: string source-backup: string source-table: string start-time: string state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .encryption-info.encryption-status code=45 The status code, which should be an enum value of google.rpc.Code. message=eos 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. .. encryption-type=labore Output only. The type of encryption used to protect this resource. kms-key-version=sed Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. .. end-time=duo 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. expire-time=sed Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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. name=no 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} . size-bytes=stet Output only. Size of the backup in bytes. source-backup=kasd 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/ source-table=et 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} . start-time=sed 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. state=et Output only. The current state of the backup.","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-patch/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-patch/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-patch/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. A mask specifying which fields (e.g. expire_time ) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.","title":"Optional Method Properties"},{"location":"projects_instances-clusters-backups-patch/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-set-iam-policy/","text":"Sets the access control policy on a Table or Backup resource. Replaces any existing policy. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-set-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=et 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. version=25 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 . .. update-mask=erat 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: &#34;bindings, etag&#34; About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Set Iam Policy"},{"location":"projects_instances-clusters-backups-set-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-set-iam-policy ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-set-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-set-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=et 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. version=25 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 . .. update-mask=erat 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: &#34;bindings, etag&#34;","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-set-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-set-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-set-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-backups-test-iam-permissions/","text":"Returns permissions that the caller has on the specified Table or Backup resource. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-test-iam-permissions ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=sed 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 . Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Backups Test Iam Permissions"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-backups-test-iam-permissions ...","title":"Scopes"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=sed 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 . Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-backups-test-iam-permissions/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-create/","text":"Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-create ... Required Scalar Argument <parent> (string) Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=81 Required. Maximum number of nodes to scale up to. min-serve-nodes=67 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=79 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. storage-utilization-gib-per-node=73 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. .... default-storage-type=amet. Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=consetetur 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} .. location=diam 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} . name=dolor The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=83 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. state=et Output only. The current state of the cluster. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p cluster-id=string 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 . Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Create"},{"location":"projects_instances-clusters-create/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-create ...","title":"Scopes"},{"location":"projects_instances-clusters-create/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=81 Required. Maximum number of nodes to scale up to. min-serve-nodes=67 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=79 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. storage-utilization-gib-per-node=73 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. .... default-storage-type=amet. Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=consetetur 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} .. location=diam 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} . name=dolor The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=83 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. state=et Output only. The current state of the cluster.","title":"Required Request Value"},{"location":"projects_instances-clusters-create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-create/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p cluster-id=string 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 .","title":"Optional Method Properties"},{"location":"projects_instances-clusters-create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-delete/","text":"Deletes a cluster from an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-delete ... Required Scalar Argument <name> (string) Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Delete"},{"location":"projects_instances-clusters-delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-delete ...","title":"Scopes"},{"location":"projects_instances-clusters-delete/#required-scalar-argument","text":"<name> (string) Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-get/","text":"Gets information about a cluster. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-get ... Required Scalar Argument <name> (string) Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Get"},{"location":"projects_instances-clusters-get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-get ...","title":"Scopes"},{"location":"projects_instances-clusters-get/#required-scalar-argument","text":"<name> (string) Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-hot-tablets-list/","text":"Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-hot-tablets-list ... Required Scalar Argument <parent> (string) Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p end-time=string The end time to list hot tablets. -p page-size=integer Maximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call. -p start-time=string The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Hot Tablets List"},{"location":"projects_instances-clusters-hot-tablets-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-hot-tablets-list ...","title":"Scopes"},{"location":"projects_instances-clusters-hot-tablets-list/#required-scalar-argument","text":"<parent> (string) Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster} .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-hot-tablets-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-hot-tablets-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p end-time=string The end time to list hot tablets. -p page-size=integer Maximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call. -p start-time=string The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.","title":"Optional Method Properties"},{"location":"projects_instances-clusters-hot-tablets-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-list/","text":"Lists information about clusters in an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-list ... Required Scalar Argument <parent> (string) Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = &#39;-&#39; to list Clusters for all Instances in a project, e.g., projects/myproject/instances/- . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-token=string DEPRECATED: This field is unused and ignored. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters List"},{"location":"projects_instances-clusters-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-list ...","title":"Scopes"},{"location":"projects_instances-clusters-list/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance} . Use {instance} = &#39;-&#39; to list Clusters for all Instances in a project, e.g., projects/myproject/instances/- .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-token=string DEPRECATED: This field is unused and ignored.","title":"Optional Method Properties"},{"location":"projects_instances-clusters-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-partial-update-cluster/","text":"Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-partial-update-cluster ... Required Scalar Argument <name> (string) The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=6 Required. Maximum number of nodes to scale up to. min-serve-nodes=86 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=2 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. storage-utilization-gib-per-node=81 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. .... default-storage-type=vero Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=vero 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} .. location=invidunt 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} . name=stet The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=25 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. state=elitr Output only. The current state of the cluster. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The subset of Cluster fields which should be replaced. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Partial Update Cluster"},{"location":"projects_instances-clusters-partial-update-cluster/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-partial-update-cluster ...","title":"Scopes"},{"location":"projects_instances-clusters-partial-update-cluster/#required-scalar-argument","text":"<name> (string) The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-partial-update-cluster/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=6 Required. Maximum number of nodes to scale up to. min-serve-nodes=86 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=2 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. storage-utilization-gib-per-node=81 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. .... default-storage-type=vero Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=vero 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} .. location=invidunt 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} . name=stet The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=25 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. state=elitr Output only. The current state of the cluster.","title":"Required Request Value"},{"location":"projects_instances-clusters-partial-update-cluster/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-partial-update-cluster/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-partial-update-cluster/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The subset of Cluster fields which should be replaced.","title":"Optional Method Properties"},{"location":"projects_instances-clusters-partial-update-cluster/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-clusters-update/","text":"Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-update ... Required Scalar Argument <name> (string) The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=95 Required. Maximum number of nodes to scale up to. min-serve-nodes=72 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=40 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. storage-utilization-gib-per-node=1 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. .... default-storage-type=accusam Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=takimata 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} .. location=consetetur 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} . name=voluptua. The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=29 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. state=erat Output only. The current state of the cluster. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Clusters Update"},{"location":"projects_instances-clusters-update/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-clusters-update ...","title":"Scopes"},{"location":"projects_instances-clusters-update/#required-scalar-argument","text":"<name> (string) The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* .","title":"Required Scalar Argument"},{"location":"projects_instances-clusters-update/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Cluster: cluster-config: cluster-autoscaling-config: autoscaling-limits: max-serve-nodes: integer min-serve-nodes: integer autoscaling-targets: cpu-utilization-percent: integer storage-utilization-gib-per-node: integer default-storage-type: string encryption-config: kms-key-name: string location: string name: string serve-nodes: integer state: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .cluster-config.cluster-autoscaling-config.autoscaling-limits max-serve-nodes=95 Required. Maximum number of nodes to scale up to. min-serve-nodes=72 Required. Minimum number of nodes to scale down to. ..autoscaling-targets cpu-utilization-percent=40 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. storage-utilization-gib-per-node=1 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. .... default-storage-type=accusam Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. encryption-config kms-key-name=takimata 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} .. location=consetetur 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} . name=voluptua. The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z* . serve-nodes=29 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. state=erat Output only. The current state of the cluster.","title":"Required Request Value"},{"location":"projects_instances-clusters-update/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-clusters-update/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-clusters-update/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-create/","text":"Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-create ... Required Scalar Argument <parent> (string) Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateInstanceRequest: instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string instance-id: string parent: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .instance create-time=consetetur Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=amet. 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. labels=key=sed 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. the value will be associated with the given key name=takimata The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=true Output only. Reserved for future use. state=et Output only. The current state of the instance. type=accusam The type of the instance. Defaults to PRODUCTION . .. instance-id=voluptua. 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 . parent=dolore Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project} . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Create"},{"location":"projects_instances-create/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-create ...","title":"Scopes"},{"location":"projects_instances-create/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project} .","title":"Required Scalar Argument"},{"location":"projects_instances-create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateInstanceRequest: instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string instance-id: string parent: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .instance create-time=consetetur Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=amet. 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. labels=key=sed 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. the value will be associated with the given key name=takimata The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=true Output only. Reserved for future use. state=et Output only. The current state of the instance. type=accusam The type of the instance. Defaults to PRODUCTION . .. instance-id=voluptua. 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 . parent=dolore Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project} .","title":"Required Request Value"},{"location":"projects_instances-create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-delete/","text":"Delete an instance from a project. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-delete ... Required Scalar Argument <name> (string) Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Delete"},{"location":"projects_instances-delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-delete ...","title":"Scopes"},{"location":"projects_instances-delete/#required-scalar-argument","text":"<name> (string) Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-get-iam-policy/","text":"Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-get-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=67 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 . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Get Iam Policy"},{"location":"projects_instances-get-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-get-iam-policy ...","title":"Scopes"},{"location":"projects_instances-get-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-get-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=67 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 .","title":"Required Request Value"},{"location":"projects_instances-get-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-get-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-get-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-get/","text":"Gets information about an instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-get ... Required Scalar Argument <name> (string) Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Get"},{"location":"projects_instances-get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-get ...","title":"Scopes"},{"location":"projects_instances-get/#required-scalar-argument","text":"<name> (string) Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-list/","text":"Lists information about instances in a project. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-list ... Required Scalar Argument <parent> (string) Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-token=string DEPRECATED: This field is unused and ignored. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances List"},{"location":"projects_instances-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-list ...","title":"Scopes"},{"location":"projects_instances-list/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project} .","title":"Required Scalar Argument"},{"location":"projects_instances-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-token=string DEPRECATED: This field is unused and ignored.","title":"Optional Method Properties"},{"location":"projects_instances-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-partial-update-instance/","text":"Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-partial-update-instance ... Required Scalar Argument <name> (string) The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . create-time=dolore Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=voluptua. 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. labels=key=amet. 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. the value will be associated with the given key name=ea The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=false Output only. Reserved for future use. state=lorem Output only. The current state of the instance. type=invidunt The type of the instance. Defaults to PRODUCTION . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The subset of Instance fields which should be replaced. Must be explicitly set. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Partial Update Instance"},{"location":"projects_instances-partial-update-instance/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-partial-update-instance ...","title":"Scopes"},{"location":"projects_instances-partial-update-instance/#required-scalar-argument","text":"<name> (string) The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] .","title":"Required Scalar Argument"},{"location":"projects_instances-partial-update-instance/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . create-time=dolore Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=voluptua. 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. labels=key=amet. 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. the value will be associated with the given key name=ea The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=false Output only. Reserved for future use. state=lorem Output only. The current state of the instance. type=invidunt The type of the instance. Defaults to PRODUCTION .","title":"Required Request Value"},{"location":"projects_instances-partial-update-instance/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-partial-update-instance/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-partial-update-instance/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The subset of Instance fields which should be replaced. Must be explicitly set.","title":"Optional Method Properties"},{"location":"projects_instances-partial-update-instance/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-set-iam-policy/","text":"Sets the access control policy on an instance resource. Replaces any existing policy. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-set-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=no 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. version=94 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 . .. update-mask=at 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: &#34;bindings, etag&#34; About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Set Iam Policy"},{"location":"projects_instances-set-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-set-iam-policy ...","title":"Scopes"},{"location":"projects_instances-set-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-set-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=no 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. version=94 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 . .. update-mask=at 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: &#34;bindings, etag&#34;","title":"Required Request Value"},{"location":"projects_instances-set-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-set-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-set-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-check-consistency/","text":"Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-check-consistency ... Required Scalar Argument <name> (string) Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CheckConsistencyRequest: consistency-token: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . consistency-token=sed Required. The token created using GenerateConsistencyToken for the Table. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Check Consistency"},{"location":"projects_instances-tables-check-consistency/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-check-consistency ...","title":"Scopes"},{"location":"projects_instances-tables-check-consistency/#required-scalar-argument","text":"<name> (string) Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-check-consistency/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CheckConsistencyRequest: consistency-token: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . consistency-token=sed Required. The token created using GenerateConsistencyToken for the Table.","title":"Required Request Value"},{"location":"projects_instances-tables-check-consistency/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-check-consistency/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-check-consistency/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-create/","text":"Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-create ... Required Scalar Argument <parent> (string) Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateTableRequest: table: change-stream-config: retention-period: string deletion-protection: boolean granularity: string name: string restore-info: backup-info: backup: string end-time: string source-backup: string source-table: string start-time: string source-type: string stats: average-cells-per-column: number average-columns-per-row: number logical-data-bytes: string row-count: int64 table-id: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .table.change-stream-config retention-period=sit 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. .. deletion-protection=true Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. granularity=aliquyam 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 . name=ipsum 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 , STATS_VIEW , FULL restore-info.backup-info backup=et Output only. Name of the backup. end-time=sanctus Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp. source-backup=lorem 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/ source-table=est Output only. Name of the table the backup was created from. start-time=sed Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp. .. source-type=diam The type of the restore source. ..stats average-cells-per-column=0.6446652953124616 How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in \"family:col\" and 1 cell in \"other:col\" (4 cells / 2 columns) * A row with 1 cell in \"family:col\", 7 cells in \"family:other_col\", and 7 cells in \"other:data\" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field. average-columns-per-row=0.261779375871928 How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in \"family:col\" and \"other:col\" (2 distinct columns) * A row with cells in \"family:col\", \"family:other_col\", and \"other:data\" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field. logical-data-bytes=no This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out). row-count=-85 How many rows are in the table. ... table-id=elitr 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. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Create"},{"location":"projects_instances-tables-create/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-create ...","title":"Scopes"},{"location":"projects_instances-tables-create/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateTableRequest: table: change-stream-config: retention-period: string deletion-protection: boolean granularity: string name: string restore-info: backup-info: backup: string end-time: string source-backup: string source-table: string start-time: string source-type: string stats: average-cells-per-column: number average-columns-per-row: number logical-data-bytes: string row-count: int64 table-id: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .table.change-stream-config retention-period=sit 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. .. deletion-protection=true Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. granularity=aliquyam 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 . name=ipsum 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 , STATS_VIEW , FULL restore-info.backup-info backup=et Output only. Name of the backup. end-time=sanctus Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp. source-backup=lorem 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/ source-table=est Output only. Name of the table the backup was created from. start-time=sed Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp. .. source-type=diam The type of the restore source. ..stats average-cells-per-column=0.6446652953124616 How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in \"family:col\" and 1 cell in \"other:col\" (4 cells / 2 columns) * A row with 1 cell in \"family:col\", 7 cells in \"family:other_col\", and 7 cells in \"other:data\" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field. average-columns-per-row=0.261779375871928 How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in \"family:col\" and \"other:col\" (2 distinct columns) * A row with cells in \"family:col\", \"family:other_col\", and \"other:data\" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field. logical-data-bytes=no This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out). row-count=-85 How many rows are in the table. ... table-id=elitr 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.","title":"Required Request Value"},{"location":"projects_instances-tables-create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-delete/","text":"Permanently deletes a specified table and all of its data. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-delete ... Required Scalar Argument <name> (string) Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Delete"},{"location":"projects_instances-tables-delete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-delete ...","title":"Scopes"},{"location":"projects_instances-tables-delete/#required-scalar-argument","text":"<name> (string) Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-delete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-delete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-drop-row-range/","text":"Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice . Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-drop-row-range ... Required Scalar Argument <name> (string) Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DropRowRangeRequest: delete-all-data-from-table: boolean row-key-prefix: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . delete-all-data-from-table=false Delete all rows in the table. Setting this to false is a no-op. row-key-prefix=no Delete all rows that start with this row key prefix. Prefix cannot be zero length. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Drop Row Range"},{"location":"projects_instances-tables-drop-row-range/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-drop-row-range ...","title":"Scopes"},{"location":"projects_instances-tables-drop-row-range/#required-scalar-argument","text":"<name> (string) Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-drop-row-range/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: DropRowRangeRequest: delete-all-data-from-table: boolean row-key-prefix: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . delete-all-data-from-table=false Delete all rows in the table. Setting this to false is a no-op. row-key-prefix=no Delete all rows that start with this row key prefix. Prefix cannot be zero length.","title":"Required Request Value"},{"location":"projects_instances-tables-drop-row-range/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-drop-row-range/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-drop-row-range/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-generate-consistency-token/","text":"Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-generate-consistency-token ... Required Scalar Argument <name> (string) Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GenerateConsistencyTokenRequest: can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Generate Consistency Token"},{"location":"projects_instances-tables-generate-consistency-token/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-generate-consistency-token ...","title":"Scopes"},{"location":"projects_instances-tables-generate-consistency-token/#required-scalar-argument","text":"<name> (string) Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-generate-consistency-token/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GenerateConsistencyTokenRequest: can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.","title":"Required Request Value"},{"location":"projects_instances-tables-generate-consistency-token/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-generate-consistency-token/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-generate-consistency-token/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-get-iam-policy/","text":"Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-get-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=10 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 . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Get Iam Policy"},{"location":"projects_instances-tables-get-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-get-iam-policy ...","title":"Scopes"},{"location":"projects_instances-tables-get-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-tables-get-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIamPolicyRequest: options: requested-policy-version: integer can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .options requested-policy-version=10 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 .","title":"Required Request Value"},{"location":"projects_instances-tables-get-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-get-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-get-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-get/","text":"Gets metadata information about the specified table. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-get ... Required Scalar Argument <name> (string) Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p view=string The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Get"},{"location":"projects_instances-tables-get/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-get ...","title":"Scopes"},{"location":"projects_instances-tables-get/#required-scalar-argument","text":"<name> (string) Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-get/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-get/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p view=string The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified.","title":"Optional Method Properties"},{"location":"projects_instances-tables-get/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-list/","text":"Lists all tables served from a specified instance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-list ... Required Scalar Argument <parent> (string) Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance} . Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-size=integer Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call. -p view=string The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables List"},{"location":"projects_instances-tables-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-list ...","title":"Scopes"},{"location":"projects_instances-tables-list/#required-scalar-argument","text":"<parent> (string) Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p page-size=integer Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -p page-token=string The value of next_page_token returned by a previous call. -p view=string The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.","title":"Optional Method Properties"},{"location":"projects_instances-tables-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-modify-column-families/","text":"Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-modify-column-families ... Required Scalar Argument <name> (string) Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: ModifyColumnFamiliesRequest: ignore-warnings: boolean can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . ignore-warnings=false Optional. If true, ignore safety checks when modifying the column families. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Modify Column Families"},{"location":"projects_instances-tables-modify-column-families/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-modify-column-families ...","title":"Scopes"},{"location":"projects_instances-tables-modify-column-families/#required-scalar-argument","text":"<name> (string) Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-modify-column-families/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: ModifyColumnFamiliesRequest: ignore-warnings: boolean can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . ignore-warnings=false Optional. If true, ignore safety checks when modifying the column families.","title":"Required Request Value"},{"location":"projects_instances-tables-modify-column-families/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-modify-column-families/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-modify-column-families/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-patch/","text":"Updates a specified table. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-patch ... Required Scalar Argument <name> (string) 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 , STATS_VIEW , FULL Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Table: change-stream-config: retention-period: string deletion-protection: boolean granularity: string name: string restore-info: backup-info: backup: string end-time: string source-backup: string source-table: string start-time: string source-type: string stats: average-cells-per-column: number average-columns-per-row: number logical-data-bytes: string row-count: int64 can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .change-stream-config retention-period=sadipscing 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. .. deletion-protection=true Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. granularity=sadipscing 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 . name=erat 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 , STATS_VIEW , FULL restore-info.backup-info backup=aliquyam Output only. Name of the backup. end-time=amet Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp. source-backup=est 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/ source-table=et Output only. Name of the table the backup was created from. start-time=sea Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp. .. source-type=consetetur The type of the restore source. ..stats average-cells-per-column=0.4299445546232471 How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in \"family:col\" and 1 cell in \"other:col\" (4 cells / 2 columns) * A row with 1 cell in \"family:col\", 7 cells in \"family:other_col\", and 7 cells in \"other:data\" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field. average-columns-per-row=0.7410819677361549 How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in \"family:col\" and \"other:col\" (2 distinct columns) * A row with cells in \"family:col\", \"family:other_col\", and \"other:data\" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field. logical-data-bytes=aliquyam This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out). row-count=-94 How many rows are in the table. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * change_stream_config * change_stream_config.retention_period * deletion_protection If column_families is set in update_mask , it will return an UNIMPLEMENTED error. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Patch"},{"location":"projects_instances-tables-patch/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-patch ...","title":"Scopes"},{"location":"projects_instances-tables-patch/#required-scalar-argument","text":"<name> (string) 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 , STATS_VIEW , FULL","title":"Required Scalar Argument"},{"location":"projects_instances-tables-patch/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Table: change-stream-config: retention-period: string deletion-protection: boolean granularity: string name: string restore-info: backup-info: backup: string end-time: string source-backup: string source-table: string start-time: string source-type: string stats: average-cells-per-column: number average-columns-per-row: number logical-data-bytes: string row-count: int64 can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .change-stream-config retention-period=sadipscing 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. .. deletion-protection=true Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. granularity=sadipscing 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 . name=erat 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 , STATS_VIEW , FULL restore-info.backup-info backup=aliquyam Output only. Name of the backup. end-time=amet Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp. source-backup=est 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/ source-table=et Output only. Name of the table the backup was created from. start-time=sea Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp. .. source-type=consetetur The type of the restore source. ..stats average-cells-per-column=0.4299445546232471 How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in \"family:col\" and 1 cell in \"other:col\" (4 cells / 2 columns) * A row with 1 cell in \"family:col\", 7 cells in \"family:other_col\", and 7 cells in \"other:data\" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field. average-columns-per-row=0.7410819677361549 How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in \"family:col\" and \"other:col\" (2 distinct columns) * A row with cells in \"family:col\", \"family:other_col\", and \"other:data\" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field. logical-data-bytes=aliquyam This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out). row-count=-94 How many rows are in the table.","title":"Required Request Value"},{"location":"projects_instances-tables-patch/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-patch/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-patch/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p update-mask=string Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * change_stream_config * change_stream_config.retention_period * deletion_protection If column_families is set in update_mask , it will return an UNIMPLEMENTED error.","title":"Optional Method Properties"},{"location":"projects_instances-tables-patch/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-restore/","text":"Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-restore ... Required Scalar Argument <parent> (string) Required. The name of the instance in which to create the restored table. Values are of the form projects//instances/ . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: RestoreTableRequest: backup: string table-id: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backup=duo Name of the backup from which to restore. Values are of the form projects//instances//clusters//backups/ . table-id=diam 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/ . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Restore"},{"location":"projects_instances-tables-restore/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-restore ...","title":"Scopes"},{"location":"projects_instances-tables-restore/#required-scalar-argument","text":"<parent> (string) Required. The name of the instance in which to create the restored table. Values are of the form projects//instances/ .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-restore/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: RestoreTableRequest: backup: string table-id: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . backup=duo Name of the backup from which to restore. Values are of the form projects//instances//clusters//backups/ . table-id=diam 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/ .","title":"Required Request Value"},{"location":"projects_instances-tables-restore/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-restore/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-restore/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-set-iam-policy/","text":"Sets the access control policy on a Table or Backup resource. Replaces any existing policy. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-set-iam-policy ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=est 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. version=48 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 . .. update-mask=sed 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: &#34;bindings, etag&#34; About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Set Iam Policy"},{"location":"projects_instances-tables-set-iam-policy/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-set-iam-policy ...","title":"Scopes"},{"location":"projects_instances-tables-set-iam-policy/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-tables-set-iam-policy/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: SetIamPolicyRequest: policy: etag: string version: integer update-mask: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .policy etag=est 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. version=48 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 . .. update-mask=sed 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: &#34;bindings, etag&#34;","title":"Required Request Value"},{"location":"projects_instances-tables-set-iam-policy/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-set-iam-policy/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-set-iam-policy/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-test-iam-permissions/","text":"Returns permissions that the caller has on the specified Table or Backup resource. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-test-iam-permissions ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=eos 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 . Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Test Iam Permissions"},{"location":"projects_instances-tables-test-iam-permissions/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-test-iam-permissions ...","title":"Scopes"},{"location":"projects_instances-tables-test-iam-permissions/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-tables-test-iam-permissions/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=eos 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 . Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"projects_instances-tables-test-iam-permissions/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-test-iam-permissions/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-test-iam-permissions/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-tables-undelete/","text":"Restores a specified table which was accidentally deleted. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-undelete ... Required Scalar Argument <name> (string) Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table} . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: UndeleteTableRequest: can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Tables Undelete"},{"location":"projects_instances-tables-undelete/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.table https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-tables-undelete ...","title":"Scopes"},{"location":"projects_instances-tables-undelete/#required-scalar-argument","text":"<name> (string) Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table} .","title":"Required Scalar Argument"},{"location":"projects_instances-tables-undelete/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: UndeleteTableRequest: can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.","title":"Required Request Value"},{"location":"projects_instances-tables-undelete/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-tables-undelete/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-tables-undelete/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-test-iam-permissions/","text":"Returns permissions that the caller has on the specified instance resource. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-test-iam-permissions ... Required Scalar Argument <resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=lorem 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 . Each invocation of this argument appends the given value to the array. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Test Iam Permissions"},{"location":"projects_instances-test-iam-permissions/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-test-iam-permissions ...","title":"Scopes"},{"location":"projects_instances-test-iam-permissions/#required-scalar-argument","text":"<resource> (string) REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.","title":"Required Scalar Argument"},{"location":"projects_instances-test-iam-permissions/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: TestIamPermissionsRequest: permissions: [string] can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . permissions=lorem 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 . Each invocation of this argument appends the given value to the array.","title":"Required Request Value"},{"location":"projects_instances-test-iam-permissions/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-test-iam-permissions/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-test-iam-permissions/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_instances-update/","text":"Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-update ... Required Scalar Argument <name> (string) The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . create-time=ea Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=stet 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. labels=key=dolores 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. the value will be associated with the given key name=eos The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=true Output only. Reserved for future use. state=sea Output only. The current state of the instance. type=et The type of the instance. Defaults to PRODUCTION . About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Instances Update"},{"location":"projects_instances-update/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects instances-update ...","title":"Scopes"},{"location":"projects_instances-update/#required-scalar-argument","text":"<name> (string) The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] .","title":"Required Scalar Argument"},{"location":"projects_instances-update/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: Instance: create-time: string display-name: string labels: { string: string } name: string satisfies-pzs: boolean state: string type: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . create-time=ea Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 . display-name=stet 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. labels=key=dolores 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. the value will be associated with the given key name=eos The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9] . satisfies-pzs=true Output only. Reserved for future use. state=sea Output only. The current state of the instance. type=et The type of the instance. Defaults to PRODUCTION .","title":"Required Request Value"},{"location":"projects_instances-update/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"projects_instances-update/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_instances-update/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"projects_locations-list/","text":"Lists information about the supported locations for this service. Scopes You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects locations-list ... Required Scalar Argument <name> (string) The resource that owns the locations collection, if applicable. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter to narrow down results to a preferred subset. The filtering language accepts strings like &#34;displayName=tokyo&#34; , and is documented in more detail in AIP-160 . -p page-size=integer The maximum number of results to return. If not set, the service selects a default. -p page-token=string A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Locations List"},{"location":"projects_locations-list/#scopes","text":"You will need authorization for at least one of the following scopes to make a valid call: https://www.googleapis.com/auth/bigtable.admin https://www.googleapis.com/auth/bigtable.admin.cluster https://www.googleapis.com/auth/bigtable.admin.instance https://www.googleapis.com/auth/cloud-bigtable.admin https://www.googleapis.com/auth/cloud-bigtable.admin.cluster https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only If unset, the scope for this method defaults to https://www.googleapis.com/auth/bigtable.admin . You can set the scope for this method like this: bigtableadmin2 --scope <scope> projects locations-list ...","title":"Scopes"},{"location":"projects_locations-list/#required-scalar-argument","text":"<name> (string) The resource that owns the locations collection, if applicable.","title":"Required Scalar Argument"},{"location":"projects_locations-list/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"projects_locations-list/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p filter=string A filter to narrow down results to a preferred subset. The filtering language accepts strings like &#34;displayName=tokyo&#34; , and is documented in more detail in AIP-160 . -p page-size=integer The maximum number of results to return. If not set, the service selects a default. -p page-token=string A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.","title":"Optional Method Properties"},{"location":"projects_locations-list/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"}]}