rollouts

Creates, updates, deletes, gets or lists a rollouts resource.

Overview

Name	rollouts
Type	Resource
Id	firebase.apphosting.rollouts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the rollout. Format: projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}.
annotations	object	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.
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.
createTime	string (google-datetime)	Output only. Time at which the rollout was created.
deleteTime	string (google-datetime)	Output only. Time at which the rollout was deleted.
displayName	string	Optional. Human-readable name. 63 character limit.
error	object	Output only. A status and (human readable) error message for the rollout, if in a FAILED state. (id: Status)
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.
labels	object	Optional. Unstructured key value map that can be used to organize and categorize objects.
reconciling	boolean	Output only. A field that, if true, indicates that the Rollout currently has an LRO.
state	string	Output only. The state of the rollout.
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the rollout was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the rollout. Format: projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}.
annotations	object	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.
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.
createTime	string (google-datetime)	Output only. Time at which the rollout was created.
deleteTime	string (google-datetime)	Output only. Time at which the rollout was deleted.
displayName	string	Optional. Human-readable name. 63 character limit.
error	object	Output only. A status and (human readable) error message for the rollout, if in a FAILED state. (id: Status)
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.
labels	object	Optional. Unstructured key value map that can be used to organize and categorize objects.
reconciling	boolean	Output only. A field that, if true, indicates that the Rollout currently has an LRO.
state	string	Output only. The state of the rollout.
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. Time at which the rollout was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backendsId, rolloutsId		Gets information about a rollout.
list	select	projectsId, locationsId, backendsId	pageSize, pageToken, filter, orderBy, showDeleted	Lists rollouts for a backend.
create	insert	projectsId, locationsId, backendsId	rolloutId, requestId, validateOnly	Creates a new rollout for a backend.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backendsId	string
locationsId	string
projectsId	string
rolloutsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
rolloutId	string
showDeleted	boolean
validateOnly	boolean

SELECT examples

get

Gets information about a rollout.

SELECT
name,
annotations,
build,
createTime,
deleteTime,
displayName,
error,
etag,
labels,
reconciling,
state,
uid,
updateTime
FROM firebase.apphosting.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendsId = '{{ backendsId }}' -- required
AND rolloutsId = '{{ rolloutsId }}' -- required;

list

Lists rollouts for a backend.

SELECT
name,
annotations,
build,
createTime,
deleteTime,
displayName,
error,
etag,
labels,
reconciling,
state,
uid,
updateTime
FROM firebase.apphosting.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendsId = '{{ backendsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Creates a new rollout for a backend.

INSERT INTO firebase.apphosting.rollouts (
data__name,
data__displayName,
data__build,
data__labels,
data__annotations,
projectsId,
locationsId,
backendsId,
rolloutId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ build }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ backendsId }}',
'{{ rolloutId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: rollouts
  props:
    - name: projectsId
      value: string
      description: Required parameter for the rollouts resource.
    - name: locationsId
      value: string
      description: Required parameter for the rollouts resource.
    - name: backendsId
      value: string
      description: Required parameter for the rollouts resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.
        
    - name: displayName
      value: string
      description: >
        Optional. Human-readable name. 63 character limit.
        
    - name: build
      value: string
      description: >
        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.
        
    - name: labels
      value: object
      description: >
        Optional. Unstructured key value map that can be used to organize and categorize objects.
        
    - name: annotations
      value: object
      description: >
        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.
        
    - name: rolloutId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean