REST Resource: projects.locations.agents.environments.deployments

Resource: Deployment

Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.

JSON representation
{
  "name": string,
  "flowVersion": string,
  "state": enum (State),
  "result": {
    object (Result)
  },
  "startTime": string,
  "endTime": string
}
Fields
name

string

The name of the deployment. Format: projects//locations//agents//environments//deployments/.

flowVersion

string

The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.

state

enum (State)

The current state of the deployment.

result

object (Result)

Result of the deployment.

startTime

string (Timestamp format)

Start time of this deployment.

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

endTime

string (Timestamp format)

End time of this deployment.

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

The state of the deployment.

Enums
STATE_UNSPECIFIED State unspecified.
RUNNING The deployment is running.
SUCCEEDED The deployment succeeded.
FAILED The deployment failed.

Result

Result of the deployment.

JSON representation
{
  "deploymentTestResults": [
    string
  ],
  "experiment": string
}
Fields
deploymentTestResults[]

string

Results of test cases running before the deployment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

experiment

string

The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.

Methods

get

Retrieves the specified Deployment.

list

Returns the list of all deployments in the specified Environment.