1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.continuousTestResults.html">continuousTestResults()</a></code> 79</p> 80<p class="firstline">Returns the continuousTestResults Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.deployments.html">deployments()</a></code> 84</p> 85<p class="firstline">Returns the deployments Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.experiments.html">experiments()</a></code> 89</p> 90<p class="firstline">Returns the experiments Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.sessions.html">sessions()</a></code> 94</p> 95<p class="firstline">Returns the sessions Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="#close">close()</a></code></p> 99<p class="firstline">Close httplib2 connections.</p> 100<p class="toc_element"> 101 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 102<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> 103<p class="toc_element"> 104 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 105<p class="firstline">Deletes the specified Environment.</p> 106<p class="toc_element"> 107 <code><a href="#deployFlow">deployFlow(environment, body=None, x__xgafv=None)</a></code></p> 108<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> 109<p class="toc_element"> 110 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 111<p class="firstline">Retrieves the specified Environment.</p> 112<p class="toc_element"> 113 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 114<p class="firstline">Returns the list of all environments in the specified Agent.</p> 115<p class="toc_element"> 116 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 117<p class="firstline">Retrieves the next page of results.</p> 118<p class="toc_element"> 119 <code><a href="#lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 120<p class="firstline">Looks up the history of the specified Environment.</p> 121<p class="toc_element"> 122 <code><a href="#lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</a></code></p> 123<p class="firstline">Retrieves the next page of results.</p> 124<p class="toc_element"> 125 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 126<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> 127<p class="toc_element"> 128 <code><a href="#runContinuousTest">runContinuousTest(environment, body=None, x__xgafv=None)</a></code></p> 129<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> 130<h3>Method Details</h3> 131<div class="method"> 132 <code class="details" id="close">close()</code> 133 <pre>Close httplib2 connections.</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 138 <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 139 140Args: 141 parent: string, Required. The Agent to create an Environment for. Format: `projects//locations//agents/`. (required) 142 body: object, The request body. 143 The object takes the form of: 144 145{ # 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. 146 "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. 147 "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. 148 "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`. 149 "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment. 150 "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day. 151 "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false. 152 "testCases": [ # 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/` 153 "A String", 154 ], 155 }, 156 "updateTime": "A String", # Output only. Update time of this environment. 157 "versionConfigs": [ # Required. 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. 158 { # Configuration for the version. 159 "version": "A String", # Required. Format: projects//locations//agents//flows//versions/. 160 }, 161 ], 162} 163 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169Returns: 170 An object of the form: 171 172 { # This resource represents a long-running operation that is the result of a network API call. 173 "done": 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. 174 "error": { # 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. 175 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 176 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 177 { 178 "a_key": "", # Properties of the object. Contains field @type with type URL. 179 }, 180 ], 181 "message": "A String", # 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. 182 }, 183 "metadata": { # 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. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186 "name": "A String", # 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}`. 187 "response": { # The normal response of the operation in case of success. 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`. 188 "a_key": "", # Properties of the object. Contains field @type with type URL. 189 }, 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 195 <pre>Deletes the specified Environment. 196 197Args: 198 name: string, Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`. (required) 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="deployFlow">deployFlow(environment, body=None, x__xgafv=None)</code> 213 <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 214 215Args: 216 environment: string, Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`. (required) 217 body: object, The request body. 218 The object takes the form of: 219 220{ # The request message for Environments.DeployFlow. 221 "flowVersion": "A String", # Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`. 222} 223 224 x__xgafv: string, V1 error format. 225 Allowed values 226 1 - v1 error format 227 2 - v2 error format 228 229Returns: 230 An object of the form: 231 232 { # This resource represents a long-running operation that is the result of a network API call. 233 "done": 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. 234 "error": { # 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. 235 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 236 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 237 { 238 "a_key": "", # Properties of the object. Contains field @type with type URL. 239 }, 240 ], 241 "message": "A String", # 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. 242 }, 243 "metadata": { # 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. 244 "a_key": "", # Properties of the object. Contains field @type with type URL. 245 }, 246 "name": "A String", # 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}`. 247 "response": { # The normal response of the operation in case of success. 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`. 248 "a_key": "", # Properties of the object. Contains field @type with type URL. 249 }, 250}</pre> 251</div> 252 253<div class="method"> 254 <code class="details" id="get">get(name, x__xgafv=None)</code> 255 <pre>Retrieves the specified Environment. 256 257Args: 258 name: string, Required. The name of the Environment. Format: `projects//locations//agents//environments/`. (required) 259 x__xgafv: string, V1 error format. 260 Allowed values 261 1 - v1 error format 262 2 - v2 error format 263 264Returns: 265 An object of the form: 266 267 { # 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. 268 "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. 269 "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. 270 "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`. 271 "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment. 272 "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day. 273 "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false. 274 "testCases": [ # 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/` 275 "A String", 276 ], 277 }, 278 "updateTime": "A String", # Output only. Update time of this environment. 279 "versionConfigs": [ # Required. 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. 280 { # Configuration for the version. 281 "version": "A String", # Required. Format: projects//locations//agents//flows//versions/. 282 }, 283 ], 284}</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 289 <pre>Returns the list of all environments in the specified Agent. 290 291Args: 292 parent: string, Required. The Agent to list all environments for. Format: `projects//locations//agents/`. (required) 293 pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100. 294 pageToken: string, The next_page_token value returned from a previous list request. 295 x__xgafv: string, V1 error format. 296 Allowed values 297 1 - v1 error format 298 2 - v2 error format 299 300Returns: 301 An object of the form: 302 303 { # The response message for Environments.ListEnvironments. 304 "environments": [ # 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't the last page. 305 { # 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. 306 "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. 307 "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. 308 "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`. 309 "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment. 310 "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day. 311 "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false. 312 "testCases": [ # 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/` 313 "A String", 314 ], 315 }, 316 "updateTime": "A String", # Output only. Update time of this environment. 317 "versionConfigs": [ # Required. 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. 318 { # Configuration for the version. 319 "version": "A String", # Required. Format: projects//locations//agents//flows//versions/. 320 }, 321 ], 322 }, 323 ], 324 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 325}</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 330 <pre>Retrieves the next page of results. 331 332Args: 333 previous_request: The request for the previous page. (required) 334 previous_response: The response from the request for the previous page. (required) 335 336Returns: 337 A request object that you can call 'execute()' on to request the next 338 page. Returns None if there are no more items in the collection. 339 </pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="lookupEnvironmentHistory">lookupEnvironmentHistory(name, pageSize=None, pageToken=None, x__xgafv=None)</code> 344 <pre>Looks up the history of the specified Environment. 345 346Args: 347 name: string, Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`. (required) 348 pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. 349 pageToken: string, The next_page_token value returned from a previous list request. 350 x__xgafv: string, V1 error format. 351 Allowed values 352 1 - v1 error format 353 2 - v2 error format 354 355Returns: 356 An object of the form: 357 358 { # The response message for Environments.LookupEnvironmentHistory. 359 "environments": [ # Represents a list of snapshots for an environment. Time of the snapshots is stored in `update_time`. 360 { # 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. 361 "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. 362 "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. 363 "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`. 364 "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment. 365 "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day. 366 "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false. 367 "testCases": [ # 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/` 368 "A String", 369 ], 370 }, 371 "updateTime": "A String", # Output only. Update time of this environment. 372 "versionConfigs": [ # Required. 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. 373 { # Configuration for the version. 374 "version": "A String", # Required. Format: projects//locations//agents//flows//versions/. 375 }, 376 ], 377 }, 378 ], 379 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 380}</pre> 381</div> 382 383<div class="method"> 384 <code class="details" id="lookupEnvironmentHistory_next">lookupEnvironmentHistory_next(previous_request, previous_response)</code> 385 <pre>Retrieves the next page of results. 386 387Args: 388 previous_request: The request for the previous page. (required) 389 previous_response: The response from the request for the previous page. (required) 390 391Returns: 392 A request object that you can call 'execute()' on to request the next 393 page. Returns None if there are no more items in the collection. 394 </pre> 395</div> 396 397<div class="method"> 398 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 399 <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 400 401Args: 402 name: string, The name of the environment. Format: `projects//locations//agents//environments/`. (required) 403 body: object, The request body. 404 The object takes the form of: 405 406{ # 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. 407 "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. 408 "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. 409 "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`. 410 "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment. 411 "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day. 412 "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false. 413 "testCases": [ # 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/` 414 "A String", 415 ], 416 }, 417 "updateTime": "A String", # Output only. Update time of this environment. 418 "versionConfigs": [ # Required. 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. 419 { # Configuration for the version. 420 "version": "A String", # Required. Format: projects//locations//agents//flows//versions/. 421 }, 422 ], 423} 424 425 updateMask: string, Required. The mask to control which fields get updated. 426 x__xgafv: string, V1 error format. 427 Allowed values 428 1 - v1 error format 429 2 - v2 error format 430 431Returns: 432 An object of the form: 433 434 { # This resource represents a long-running operation that is the result of a network API call. 435 "done": 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. 436 "error": { # 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. 437 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 438 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 439 { 440 "a_key": "", # Properties of the object. Contains field @type with type URL. 441 }, 442 ], 443 "message": "A String", # 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. 444 }, 445 "metadata": { # 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. 446 "a_key": "", # Properties of the object. Contains field @type with type URL. 447 }, 448 "name": "A String", # 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}`. 449 "response": { # The normal response of the operation in case of success. 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`. 450 "a_key": "", # Properties of the object. Contains field @type with type URL. 451 }, 452}</pre> 453</div> 454 455<div class="method"> 456 <code class="details" id="runContinuousTest">runContinuousTest(environment, body=None, x__xgafv=None)</code> 457 <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 458 459Args: 460 environment: string, Required. Format: `projects//locations//agents//environments/`. (required) 461 body: object, The request body. 462 The object takes the form of: 463 464{ # The request message for Environments.RunContinuousTest. 465} 466 467 x__xgafv: string, V1 error format. 468 Allowed values 469 1 - v1 error format 470 2 - v2 error format 471 472Returns: 473 An object of the form: 474 475 { # This resource represents a long-running operation that is the result of a network API call. 476 "done": 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. 477 "error": { # 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. 478 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 479 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 480 { 481 "a_key": "", # Properties of the object. Contains field @type with type URL. 482 }, 483 ], 484 "message": "A String", # 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. 485 }, 486 "metadata": { # 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. 487 "a_key": "", # Properties of the object. Contains field @type with type URL. 488 }, 489 "name": "A String", # 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}`. 490 "response": { # The normal response of the operation in case of success. 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`. 491 "a_key": "", # Properties of the object. Contains field @type with type URL. 492 }, 493}</pre> 494</div> 495 496</body></html>