Resource: Rollout
A single rollout of a build for a backend.
JSON representation |
---|
{ "name": string, "displayName": string, "state": enum ( |
Fields | |
---|---|
name |
Identifier. The resource name of the rollout. Format:
|
displayName |
Optional. Human-readable name. 63 character limit. |
state |
Output only. The state of the rollout. |
error |
Output only. A status and (human readable) error message for the rollout, if in a |
build |
Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. |
reconciling |
Output only. A field that, if true, indicates that the Rollout currently has an LRO. |
createTime |
Output only. Time at which the rollout was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Time at which the rollout was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. Time at which the rollout was deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Unstructured key value map that can be used to organize and categorize objects. An object containing a list of |
annotations |
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. An object containing a list of |
uid |
Output only. System-assigned, unique identifier. |
etag |
Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |
State
The state of the rollout.
Enums | |
---|---|
STATE_UNSPECIFIED |
The rollout is in an unknown state. |
QUEUED |
The rollout is waiting for actuation to begin. This may be because it is waiting on another rollout to complete. |
PENDING_BUILD |
The rollout is waiting for the build process to complete, which builds the code and sets up the underlying infrastructure. |
PROGRESSING |
The rollout has started and is actively modifying traffic. |
PAUSED |
The rollout has been paused due to either being manually paused or a PAUSED stage. This should be set while paused = true . |
SUCCEEDED |
The rollout has completed. |
FAILED |
The rollout has failed. See error for more information. |
CANCELLED |
The rollout has been cancelled. |
Methods |
|
---|---|
|
Creates a new rollout for a backend. |
|
Gets information about a rollout. |
|
Lists rollouts for a backend. |