REST Resource: projects.locations.backends.rollouts
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Rollout
A single rollout of a build for a backend.
JSON representation |
{
"name": string,
"displayName": string,
"state": enum (Rollout.State ),
"error": {
object (Status )
},
"build": string,
"reconciling": boolean,
"createTime": string,
"updateTime": string,
"deleteTime": string,
"labels": {
string: string,
...
},
"annotations": {
string: string,
...
},
"uid": string,
"etag": string
} |
Fields |
name |
string
Identifier. The resource name of the rollout. Format: projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId} .
|
displayName |
string
Optional. Human-readable name. 63 character limit.
|
state |
enum (Rollout.State )
Output only. The state of the rollout.
|
error |
object (Status )
Output only. A status and (human readable) error message for the rollout, if in a FAILED state.
|
build |
string
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 |
boolean
Output only. A field that, if true, indicates that the Rollout currently has an LRO.
|
createTime |
string (Timestamp format)
Output only. Time at which the rollout was created. 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" .
|
updateTime |
string (Timestamp format)
Output only. Time at which the rollout was last updated. 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" .
|
deleteTime |
string (Timestamp format)
Output only. Time at which the rollout was deleted. 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" .
|
labels |
map (key: string, value: string)
Optional. Unstructured key value map that can be used to organize and categorize objects. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
annotations |
map (key: string, value: string)
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 "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
uid |
string
Output only. System-assigned, unique identifier.
|
etag |
string
Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
|
Rollout.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. |
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# REST Resource: projects.locations.backends.rollouts\n\nResource: Rollout\n-----------------\n\nA single rollout of a build for a backend.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"state\": enum (/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts#Rollout.State), \"error\": { object (/docs/reference/apphosting/rest/v1/Status) }, \"build\": string, \"reconciling\": boolean, \"createTime\": string, \"updateTime\": string, \"deleteTime\": string, \"labels\": { string: string, ... }, \"annotations\": { string: string, ... }, \"uid\": string, \"etag\": string } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`. |\n| `displayName` | `string` Optional. Human-readable name. 63 character limit. |\n| `state` | `enum (`[Rollout.State](/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts#Rollout.State)`)` Output only. The state of the rollout. |\n| `error` | `object (`[Status](/docs/reference/apphosting/rest/v1/Status)`)` Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state. |\n| `build` | `string` 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. |\n| `reconciling` | `boolean` Output only. A field that, if true, indicates that the Rollout currently has an LRO. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time at which the rollout was created. 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\"`. |\n| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time at which the rollout was last updated. 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\"`. |\n| `deleteTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time at which the rollout was deleted. 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\"`. |\n| `labels` | `map (key: string, value: string)` Optional. Unstructured key value map that can be used to organize and categorize objects. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `annotations` | `map (key: string, value: string)` 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 `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `uid` | `string` Output only. System-assigned, unique identifier. |\n| `etag` | `string` Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |\n\nRollout.State\n-------------\n\nThe state of the rollout.\n\n| Enums ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | The rollout is in an unknown state. |\n| `QUEUED` | The rollout is waiting for actuation to begin. This may be because it is waiting on another rollout to complete. |\n| `PENDING_BUILD` | The rollout is waiting for the build process to complete, which builds the code and sets up the underlying infrastructure. |\n| `PROGRESSING` | The rollout has started and is actively modifying traffic. |\n| `SUCCEEDED` | The rollout has completed. |\n| `FAILED` | The rollout has failed. See error for more information. |\n| `CANCELLED` | The rollout has been cancelled. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------|--------------------------------------|\n| ### [create](/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts/create) | Creates a new rollout for a backend. |\n| ### [get](/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts/get) | Gets information about a rollout. |\n| ### [list](/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts/list) | Lists rollouts for a backend. |"]]