REST Resource: projects.agent.environments

Resource: Environment

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.

For more information, see the versions and environments guide.

JSON representation
{
  "name": string,
  "description": string,
  "agentVersion": string,
  "state": enum (State),
  "updateTime": string
}
Fields
name

string

Output only. The unique identifier of this agent environment. Supported formats: - projects/<Project Number / ID>/agent/environments/<Environment ID> - projects/<Project Number / ID>/locations/<Location ID>/agent/environments/<Environment ID>

description

string

Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.

agentVersion

string

Optional. The agent version loaded into this environment. Supported formats: - projects/<Project ID>/agent/versions/<Version ID> - projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>

state

enum (State)

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

updateTime

string (Timestamp format)

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

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

State

Represents an environment state. When an environment is pointed to a new agent version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state.

Enums
STATE_UNSPECIFIED Not specified. This value is not used.
STOPPED Stopped.
LOADING Loading.
RUNNING Running.

Methods

list

Returns the list of all non-draft environments of the specified agent.