Updates the debug mask singleton resource for an environment.

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: apigee1 --scope <scope> organizations environments-update-debugmask ...

Required Scalar Argument

  • <name> (string)
    • Name of the debug mask.

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:

GoogleCloudApigeeV1DebugMask:
  fault-json-paths: [string]
  fault-x-paths: [string]
  name: string
  namespaces: { string: string }
  request-json-paths: [string]
  request-x-paths: [string]
  response-json-paths: [string]
  response-x-paths: [string]
  variables: [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 . fault-json-paths=et
    • List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
    • Each invocation of this argument appends the given value to the array.
  • fault-x-paths=dolor
    • List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
    • Each invocation of this argument appends the given value to the array.
  • name=diam
    • Name of the debug mask.
  • namespaces=key=elitr
    • Map of namespaces to URIs.
    • the value will be associated with the given key
  • request-json-paths=sea
    • List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
    • Each invocation of this argument appends the given value to the array.
  • request-x-paths=vero
    • List of XPaths that specify the XML elements to be filtered from XML request message payloads.
    • Each invocation of this argument appends the given value to the array.
  • response-json-paths=et
    • List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
    • Each invocation of this argument appends the given value to the array.
  • response-x-paths=lorem
    • List of XPaths that specify the XML elements to be filtered from XML response message payloads.
    • Each invocation of this argument appends the given value to the array.
  • variables=sit
    • List of variables that should be masked from the debug output.
    • 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 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 replace-repeated-fields=boolean

    • Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).

  • -p update-mask=string

    • Field debug mask to support partial updates.

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