Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.


You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

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: dialogflow2 --scope <scope> projects agent-environments-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.

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:

  agent-version: string
  description: string
    display-name: string
    enabled: boolean
      is-cloud-function: boolean
      password: string
      request-headers: { string: string }
      uri: string
      username: string
    name: string
  name: string
  state: string
    enable-text-to-speech: boolean
    output-audio-encoding: string
    sample-rate-hertz: integer
  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 . agent-version=no
    • Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • description=stet
    • Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
  • fulfillment display-name=kasd
    • Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
  • enabled=true
    • Optional. Whether fulfillment is enabled.
  • generic-web-service is-cloud-function=true
    • Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
  • password=vero
    • Optional. The password for HTTP Basic authentication.
  • request-headers=key=erat
    • Optional. The HTTP request headers to send together with fulfillment requests.
    • the value will be associated with the given key
  • uri=sed
    • Required. The fulfillment URI for receiving POST requests. It must use https protocol.
  • username=duo

    • Optional. The user name for HTTP Basic authentication.
  • .. name=dolore

    • Required. The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
  • .. name=et

    • Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • state=voluptua.
    • Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
  • text-to-speech-settings enable-text-to-speech=false
    • Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
  • output-audio-encoding=diam
    • Required. Audio encoding of the synthesized audio content.
  • sample-rate-hertz=52

    • Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
  • .. update-time=et

    • Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.

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 allow-load-to-draft-and-discard-changes=boolean

    • Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).
  • -p update-mask=string

    • Required. The mask to control which fields get updated.

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