rollouts

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

Overview

Name	rollouts
Type	Resource
Id	google.servicemanagement.rollouts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
createTime	string (google-datetime)	Creation time of the rollout. Readonly.
createdBy	string	The user who created the Rollout. Readonly.
deleteServiceStrategy	object	The strategy associated with a rollout to delete a ManagedService. Readonly. (id: DeleteServiceStrategy)
rolloutId	string	Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
serviceName	string	The name of the service associated with this Rollout.
status	string	The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
trafficPercentStrategy	object	Google Service Control selects service configurations based on traffic percentage. (id: TrafficPercentStrategy)
universe	string	The TPC universe which the rollout will be rolled out to.

list

Successful response

Name	Datatype	Description
createTime	string (google-datetime)	Creation time of the rollout. Readonly.
createdBy	string	The user who created the Rollout. Readonly.
deleteServiceStrategy	object	The strategy associated with a rollout to delete a ManagedService. Readonly. (id: DeleteServiceStrategy)
rolloutId	string	Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
serviceName	string	The name of the service associated with this Rollout.
status	string	The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
trafficPercentStrategy	object	Google Service Control selects service configurations based on traffic percentage. (id: TrafficPercentStrategy)
universe	string	The TPC universe which the rollout will be rolled out to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	serviceName, rolloutId		Gets a service configuration rollout.
list	select	serviceName	pageToken, pageSize, filter	Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
create	insert	serviceName		Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation

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
rolloutId	string
serviceName	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a service configuration rollout.

SELECT
createTime,
createdBy,
deleteServiceStrategy,
rolloutId,
serviceName,
status,
trafficPercentStrategy,
universe
FROM google.servicemanagement.rollouts
WHERE serviceName = '{{ serviceName }}' -- required
AND rolloutId = '{{ rolloutId }}' -- required;

list

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

SELECT
createTime,
createdBy,
deleteServiceStrategy,
rolloutId,
serviceName,
status,
trafficPercentStrategy,
universe
FROM google.servicemanagement.rollouts
WHERE serviceName = '{{ serviceName }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation

INSERT INTO google.servicemanagement.rollouts (
data__rolloutId,
data__createTime,
data__createdBy,
data__status,
data__trafficPercentStrategy,
data__deleteServiceStrategy,
data__serviceName,
data__universe,
serviceName
)
SELECT 
'{{ rolloutId }}',
'{{ createTime }}',
'{{ createdBy }}',
'{{ status }}',
'{{ trafficPercentStrategy }}',
'{{ deleteServiceStrategy }}',
'{{ serviceName }}',
'{{ universe }}',
'{{ serviceName }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: rollouts
  props:
    - name: serviceName
      value: string
      description: Required parameter for the rollouts resource.
    - name: rolloutId
      value: string
      description: >
        Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
        
    - name: createTime
      value: string
      description: >
        Creation time of the rollout. Readonly.
        
    - name: createdBy
      value: string
      description: >
        The user who created the Rollout. Readonly.
        
    - name: status
      value: string
      description: >
        The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
        
      valid_values: ['ROLLOUT_STATUS_UNSPECIFIED', 'IN_PROGRESS', 'SUCCESS', 'CANCELLED', 'FAILED', 'PENDING', 'FAILED_ROLLED_BACK']
    - name: trafficPercentStrategy
      value: object
      description: >
        Google Service Control selects service configurations based on traffic percentage.
        
    - name: deleteServiceStrategy
      value: object
      description: >
        The strategy associated with a rollout to delete a `ManagedService`. Readonly.
        
    - name: serviceName
      value: string
      description: >
        The name of the service associated with this Rollout.
        
    - name: universe
      value: string
      description: >
        The TPC universe which the rollout will be rolled out to.