File: dialogflow_v3beta1.projects.locations.agents.environments.html

package info (click to toggle)
python-googleapi 2.180.0-1
links: PTS
area: main
in suites: forky, sid
size: 527,124 kB
sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (891 lines) | stat: -rw-r--r-- 91,770 bytes
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.environments.html">environments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.continuousTestResults.html">continuousTestResults()</a></code>
</p>
<p class="firstline">Returns the continuousTestResults Resource.</p>

<p class="toc_element">
  <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>

<p class="toc_element">
  <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.experiments.html">experiments()</a></code>
</p>
<p class="firstline">Returns the experiments Resource.</p>

<p class="toc_element">
  <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.sessions.html">sessions()</a></code>
</p>
<p class="firstline">Returns the sessions Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified Environment.</p>
<p class="toc_element">
  <code><a href="#deployFlow">deployFlow(environment, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified Environment.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all environments in the specified Agent.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up the history of the specified Environment.</p>
<p class="toc_element">
  <code><a href="#lookupEnvironmentHistory_next">lookupEnvironmentHistory_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment</p>
<p class="toc_element">
  <code><a href="#runContinuousTest">runContinuousTest(environment, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Kicks off a continuous test under the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunContinuousTestMetadata - `response`: RunContinuousTestResponse</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment

Args:
  parent: string, Required. The Agent to create an Environment for. Format: `projects//locations//agents/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
  &quot;description&quot;: &quot;A String&quot;, # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
  &quot;name&quot;: &quot;A String&quot;, # The name of the environment. Format: `projects//locations//agents//environments/`.
  &quot;testCasesConfig&quot;: { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
    &quot;enableContinuousRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
    &quot;enablePredeploymentRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
    &quot;testCases&quot;: [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`
      &quot;A String&quot;,
    ],
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of this environment.
  &quot;versionConfigs&quot;: [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
    { # Configuration for the version.
      &quot;version&quot;: &quot;A String&quot;, # Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/. Format for tool version: projects//locations//agents//tools//versions/.
    },
  ],
  &quot;webhookConfig&quot;: { # Configuration for webhooks. # The webhook configuration for this environment.
    &quot;webhookOverrides&quot;: [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
      { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
        &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
        &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
          &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
            &quot;A String&quot;,
          ],
          &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
          &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
            &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
            &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
            &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
              &quot;A String&quot;,
            ],
            &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
          },
          &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
          &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
          &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
          &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
            &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
              &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            },
          },
          &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
          &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
          &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
          &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
        },
        &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
        &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
          &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
            &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
              &quot;A String&quot;,
            ],
            &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
            &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
              &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
              &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
              &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                &quot;A String&quot;,
              ],
              &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
            },
            &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
            &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
            &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
              &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              },
            },
            &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
            &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
            &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
            &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
          },
          &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
        },
        &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified Environment.

Args:
  name: string, Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="deployFlow">deployFlow(environment, body=None, x__xgafv=None)</code>
  <pre>Deploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse

Args:
  environment: string, Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for Environments.DeployFlow.
  &quot;flowVersion&quot;: &quot;A String&quot;, # Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves the specified Environment.

Args:
  name: string, Required. The name of the Environment. Format: `projects//locations//agents//environments/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
  &quot;description&quot;: &quot;A String&quot;, # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
  &quot;name&quot;: &quot;A String&quot;, # The name of the environment. Format: `projects//locations//agents//environments/`.
  &quot;testCasesConfig&quot;: { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
    &quot;enableContinuousRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
    &quot;enablePredeploymentRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
    &quot;testCases&quot;: [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`
      &quot;A String&quot;,
    ],
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of this environment.
  &quot;versionConfigs&quot;: [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
    { # Configuration for the version.
      &quot;version&quot;: &quot;A String&quot;, # Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/. Format for tool version: projects//locations//agents//tools//versions/.
    },
  ],
  &quot;webhookConfig&quot;: { # Configuration for webhooks. # The webhook configuration for this environment.
    &quot;webhookOverrides&quot;: [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
      { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
        &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
        &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
          &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
            &quot;A String&quot;,
          ],
          &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
          &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
            &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
            &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
            &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
              &quot;A String&quot;,
            ],
            &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
          },
          &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
          &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
          &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
          &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
            &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
              &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            },
          },
          &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
          &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
          &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
          &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
        },
        &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
        &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
          &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
            &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
              &quot;A String&quot;,
            ],
            &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
            &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
              &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
              &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
              &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                &quot;A String&quot;,
              ],
              &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
            },
            &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
            &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
            &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
              &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              },
            },
            &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
            &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
            &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
            &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
          },
          &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
        },
        &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns the list of all environments in the specified Agent.

Args:
  parent: string, Required. The Agent to list all environments for. Format: `projects//locations//agents/`. (required)
  pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
  pageToken: string, The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Environments.ListEnvironments.
  &quot;environments&quot;: [ # The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn&#x27;t the last page.
    { # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
      &quot;description&quot;: &quot;A String&quot;, # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
      &quot;name&quot;: &quot;A String&quot;, # The name of the environment. Format: `projects//locations//agents//environments/`.
      &quot;testCasesConfig&quot;: { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
        &quot;enableContinuousRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
        &quot;enablePredeploymentRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
        &quot;testCases&quot;: [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`
          &quot;A String&quot;,
        ],
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of this environment.
      &quot;versionConfigs&quot;: [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
        { # Configuration for the version.
          &quot;version&quot;: &quot;A String&quot;, # Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/. Format for tool version: projects//locations//agents//tools//versions/.
        },
      ],
      &quot;webhookConfig&quot;: { # Configuration for webhooks. # The webhook configuration for this environment.
        &quot;webhookOverrides&quot;: [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
          { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
            &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
            &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
            &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
              &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
                &quot;A String&quot;,
              ],
              &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
              &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
                &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
                &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
                &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                  &quot;A String&quot;,
                ],
                &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
              },
              &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
              &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
              &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
                &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                  &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                },
              },
              &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
              &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
              &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
              &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
            },
            &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
            &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
              &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
                &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
                  &quot;A String&quot;,
                ],
                &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
                &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
                  &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
                  &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
                  &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                    &quot;A String&quot;,
                  ],
                  &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                  &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
                },
                &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
                &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
                &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
                  &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                    &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                  },
                },
                &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
                &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
                &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
              },
              &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
            },
            &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
          },
        ],
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Looks up the history of the specified Environment.

Args:
  name: string, Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`. (required)
  pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
  pageToken: string, The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Environments.LookupEnvironmentHistory.
  &quot;environments&quot;: [ # Represents a list of snapshots for an environment. Time of the snapshots is stored in `update_time`.
    { # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
      &quot;description&quot;: &quot;A String&quot;, # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
      &quot;name&quot;: &quot;A String&quot;, # The name of the environment. Format: `projects//locations//agents//environments/`.
      &quot;testCasesConfig&quot;: { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
        &quot;enableContinuousRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
        &quot;enablePredeploymentRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
        &quot;testCases&quot;: [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`
          &quot;A String&quot;,
        ],
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of this environment.
      &quot;versionConfigs&quot;: [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
        { # Configuration for the version.
          &quot;version&quot;: &quot;A String&quot;, # Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/. Format for tool version: projects//locations//agents//tools//versions/.
        },
      ],
      &quot;webhookConfig&quot;: { # Configuration for webhooks. # The webhook configuration for this environment.
        &quot;webhookOverrides&quot;: [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
          { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
            &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
            &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
            &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
              &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
                &quot;A String&quot;,
              ],
              &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
              &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
                &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
                &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
                &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                  &quot;A String&quot;,
                ],
                &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
              },
              &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
              &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
              &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
                &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                  &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                },
              },
              &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
              &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
              &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
              &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
            },
            &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
            &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
              &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
                &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
                  &quot;A String&quot;,
                ],
                &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
                &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
                  &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
                  &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
                  &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                    &quot;A String&quot;,
                  ],
                  &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                  &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
                },
                &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
                &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
                &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
                  &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                    &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                  },
                },
                &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
                &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
                &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
              },
              &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
            },
            &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
          },
        ],
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>

<div class="method">
    <code class="details" id="lookupEnvironmentHistory_next">lookupEnvironmentHistory_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment

Args:
  name: string, The name of the environment. Format: `projects//locations//agents//environments/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
  &quot;description&quot;: &quot;A String&quot;, # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
  &quot;name&quot;: &quot;A String&quot;, # The name of the environment. Format: `projects//locations//agents//environments/`.
  &quot;testCasesConfig&quot;: { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
    &quot;enableContinuousRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
    &quot;enablePredeploymentRun&quot;: True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
    &quot;testCases&quot;: [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`
      &quot;A String&quot;,
    ],
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of this environment.
  &quot;versionConfigs&quot;: [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
    { # Configuration for the version.
      &quot;version&quot;: &quot;A String&quot;, # Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/. Format for tool version: projects//locations//agents//tools//versions/.
    },
  ],
  &quot;webhookConfig&quot;: { # Configuration for webhooks. # The webhook configuration for this environment.
    &quot;webhookOverrides&quot;: [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
      { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
        &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
        &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
          &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
            &quot;A String&quot;,
          ],
          &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
          &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
            &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
            &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
            &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
              &quot;A String&quot;,
            ],
            &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
          },
          &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
          &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
          &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
          &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
            &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
              &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            },
          },
          &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
          &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
          &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
          &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
        },
        &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
        &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
          &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
            &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
              &quot;A String&quot;,
            ],
            &quot;httpMethod&quot;: &quot;A String&quot;, # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
            &quot;oauthConfig&quot;: { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
              &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID provided by the 3rd party platform.
              &quot;clientSecret&quot;: &quot;A String&quot;, # Optional. The client secret provided by the 3rd party platform.
              &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
                &quot;A String&quot;,
              ],
              &quot;secretVersionForClientSecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
            },
            &quot;parameterMapping&quot;: { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
            &quot;requestBody&quot;: &quot;A String&quot;, # Optional. Defines a custom JSON object as request body to send to flexible webhook.
            &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;secretVersionForUsernamePassword&quot;: &quot;A String&quot;, # Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`
            &quot;secretVersionsForRequestHeaders&quot;: { # Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.
              &quot;a_key&quot;: { # Represents the value of an HTTP header stored in a SecretManager secret version.
                &quot;secretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
              },
            },
            &quot;serviceAgentAuth&quot;: &quot;A String&quot;, # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
            &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
            &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
            &quot;webhookType&quot;: &quot;A String&quot;, # Optional. Type of the webhook.
          },
          &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
        },
        &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      },
    ],
  },
}

  updateMask: string, Required. The mask to control which fields get updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="runContinuousTest">runContinuousTest(environment, body=None, x__xgafv=None)</code>
  <pre>Kicks off a continuous test under the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunContinuousTestMetadata - `response`: RunContinuousTestResponse

Args:
  environment: string, Required. Format: `projects//locations//agents//environments/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for Environments.RunContinuousTest.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>