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

Resource: Deployment

Represents a 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.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

End time of this deployment.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>.
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.