REST Resource: projects.locations.agents.environments

Stay organized with collections Save and categorize content based on your preferences.

Resource: Environment

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.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "versionConfigs": [
    {
      object (VersionConfig)
    }
  ],
  "updateTime": string,
  "testCasesConfig": {
    object (TestCasesConfig)
  },
  "webhookConfig": {
    object (WebhookConfig)
  }
}
Fields
name

string

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
displayName

string

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
description

string

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
versionConfigs[]

object (VersionConfig)

A list of configurations for flow versions. You should include version configs for all flows that are reachable from [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned.
updateTime

string (Timestamp format)

Output only. Update time of this environment.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
testCasesConfig

object (TestCasesConfig)

The test cases config for continuous tests of this environment.
webhookConfig

object (WebhookConfig)

The webhook configuration for this environment.

VersionConfig

Configuration for the version.

JSON representation 
{
  "version": string
}
Fields
version

string

Required. Format: projects//locations//agents//flows//versions/.

TestCasesConfig

The configuration for continuous tests.

JSON representation 
{
  "testCases": [
    string
  ],
  "enableContinuousRun": boolean,
  "enablePredeploymentRun": boolean
}
Fields
testCases[]

string

A list of test case names to run. They should be under the same agent. Format of each test case name: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>
enableContinuousRun

boolean

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
enablePredeploymentRun

boolean

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

WebhookConfig

Configuration for webhooks.

JSON representation 
{
  "webhookOverrides": [
    {
      object (Webhook)
    }
  ]
}
Fields
webhookOverrides[]

object (Webhook)

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in genericWebService and serviceDirectory.

Methods

create

 Creates an Environment in the specified Agent.

delete

 Deletes the specified Environment.

deployFlow

 Deploys a flow to the specified Environment.

get

 Retrieves the specified Environment.

list

 Returns the list of all environments in the specified Agent.

lookupEnvironmentHistory

 Looks up the history of the specified Environment.

patch

 Updates the specified Environment.

runContinuousTest

 Kicks off a continuous test under the specified Environment.