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 ( |
Fields | |
---|---|
name |
The name of the environment. Format: |
displayName |
Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. |
description |
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. |
versionConfigs[] |
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [ |
updateTime |
Output only. Update time of this environment. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
testCasesConfig |
The test cases config for continuous tests of this environment. |
webhookConfig |
The webhook configuration for this environment. |
VersionConfig
Configuration for the version.
JSON representation |
---|
{ "version": string } |
Fields | |
---|---|
version |
Required. Both flow and playbook versions are supported. Format for flow version: projects/ |
TestCasesConfig
The configuration for continuous tests.
JSON representation |
---|
{ "testCases": [ string ], "enableContinuousRun": boolean, "enablePredeploymentRun": boolean } |
Fields | |
---|---|
testCases[] |
A list of test case names to run. They should be under the same agent. Format of each test case name: |
enableContinuousRun |
Whether to run test cases in |
enablePredeploymentRun |
Whether to run test cases in |
WebhookConfig
Configuration for webhooks.
JSON representation |
---|
{
"webhookOverrides": [
{
object ( |
Fields | |
---|---|
webhookOverrides[] |
The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in |
Methods |
|
---|---|
|
Creates an Environment in the specified Agent . |
|
Deletes the specified Environment . |
|
Deploys a flow to the specified Environment . |
|
Retrieves the specified Environment . |
|
Returns the list of all environments in the specified Agent . |
|
Looks up the history of the specified Environment . |
|
Updates the specified Environment . |
|
Kicks off a continuous test under the specified Environment . |