Update the environment resource.

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: dataplex1 --scope <scope> projects locations-lakes-environments-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

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:

GoogleCloudDataplexV1Environment:
  create-time: string
  description: string
  display-name: string
  endpoints:
    notebooks: string
    sql: string
  infrastructure-spec:
    compute:
      disk-size-gb: integer
      max-node-count: integer
      node-count: integer
    os-image:
      image-version: string
      java-libraries: [string]
      properties: { string: string }
      python-packages: [string]
  labels: { string: string }
  name: string
  session-spec:
    enable-fast-startup: boolean
    max-idle-duration: string
  session-status:
    active: boolean
  state: string
  uid: string
  update-time: 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=nonumy
    • Output only. Environment creation time.
  • description=et
    • Optional. Description of the environment.
  • display-name=sanctus
    • Optional. User friendly display name.
  • endpoints notebooks=accusam
    • Output only. URI to serve notebook APIs

  • sql=tempor

    • Output only. URI to serve SQL APIs

  • ..infrastructure-spec.compute disk-size-gb=58

    • Optional. Size in GB of the disk. Default is 100 GB.
  • max-node-count=94
    • Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.

  • node-count=92

    • Optional. Total number of nodes in the sessions created for this environment.

  • ..os-image image-version=dolor

    • Required. Dataplex Image version.
  • java-libraries=diam
    • Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
    • Each invocation of this argument appends the given value to the array.
  • properties=key=at
    • Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
    • the value will be associated with the given key

  • python-packages=erat

    • Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
    • Each invocation of this argument appends the given value to the array.

  • ... labels=key=justo

    • Optional. User defined labels for the environment.
    • the value will be associated with the given key
  • name=ipsum
    • Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
  • session-spec enable-fast-startup=false
    • Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.

  • max-idle-duration=dolores

    • Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.

  • ..session-status active=false

    • Output only. Queries over sessions to mark whether the environment is currently active or not

  • .. state=no

    • Output only. Current state of the environment.
  • uid=justo
    • Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
  • update-time=sadipscing
    • Output only. The time when the environment was last updated.

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. Mask of fields to update.

  • -p validate-only=boolean

    • Optional. Only validate the request, but do not perform mutations. The default is false.

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