Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: resourcesettings1 --scope <scope> folders settings-patch ...

Required Scalar Argument

<name> (string)
- The resource name of the setting. Must be in one of the following forms: * projects/{project_number}/settings/{setting_name} * folders/{folder_id}/settings/{setting_name} * organizations/{organization_id}/settings/{setting_name} For example, "/projects/123/settings/gcp-enableMyFeature"

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:

GoogleCloudResourcesettingsV1Setting:
  effective-value:
    boolean-value: boolean
    duration-value: string
    enum-value:
      value: string
    string-map-value:
      mappings: { string: string }
    string-set-value:
      values: [string]
    string-value: string
  etag: string
  local-value:
    boolean-value: boolean
    duration-value: string
    enum-value:
      value: string
    string-map-value:
      mappings: { string: string }
    string-set-value:
      values: [string]
    string-value: string
  metadata:
    data-type: string
    default-value:
      boolean-value: boolean
      duration-value: string
      enum-value:
        value: string
      string-map-value:
        mappings: { string: string }
      string-set-value:
        values: [string]
      string-value: string
    description: string
    display-name: string
    read-only: boolean
  name: 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 .effective-value boolean-value=true
- Defines this value as being a boolean value.
duration-value=voluptua.
- Defines this value as being a Duration.
enum-value value=at
- The value of this enum
..string-map-value mappings=key=sanctus
- The key-value pairs in the map
- the value will be associated with the given key
..string-set-value values=sed
- The strings in the set
- Each invocation of this argument appends the given value to the array.
.. string-value=amet.
- Defines this value as being a string value.
.. etag=takimata
- A fingerprint used for optimistic concurrency. See UpdateSetting for more details.
local-value boolean-value=true
- Defines this value as being a boolean value.
duration-value=duo
- Defines this value as being a Duration.
enum-value value=ipsum
- The value of this enum
..string-map-value mappings=key=gubergren
- The key-value pairs in the map
- the value will be associated with the given key
..string-set-value values=lorem
- The strings in the set
- Each invocation of this argument appends the given value to the array.
.. string-value=gubergren
- Defines this value as being a string value.
..metadata data-type=eos
- The data type for this setting.
default-value boolean-value=true
- Defines this value as being a boolean value.
duration-value=invidunt
- Defines this value as being a Duration.
enum-value value=amet
- The value of this enum
..string-map-value mappings=key=duo
- The key-value pairs in the map
- the value will be associated with the given key
..string-set-value values=ipsum
- The strings in the set
- Each invocation of this argument appends the given value to the array.
.. string-value=sed
- Defines this value as being a string value.
.. description=ut
- A detailed description of what this setting does.
display-name=gubergren
- The human readable name for this setting.
read-only=true
- A flag indicating that values of this setting cannot be modified. See documentation for the specific setting for updates and reasons.
.. name=ipsum
- The resource name of the setting. Must be in one of the following forms: * projects/{project_number}/settings/{setting_name} * folders/{folder_id}/settings/{setting_name} * organizations/{organization_id}/settings/{setting_name} For example, "/projects/123/settings/gcp-enableMyFeature"

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