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").