automations

Creates, updates, deletes, gets or lists an automations resource.

Overview

Name	automations
Type	Resource
Id	google.clouddeploy.automations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.
annotations	object	Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
createTime	string (google-datetime)	Output only. Time at which the automation was created.
description	string	Optional. Description of the Automation. Max length is 255 characters.
etag	string	Optional. The weak etag of the Automation resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
rules	array	Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
selector	object	Required. Selected resources to which the automation will be applied. (id: AutomationResourceSelector)
serviceAccount	string	Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
suspended	boolean	Optional. When Suspended, automation is deactivated from execution.
uid	string	Output only. Unique identifier of the Automation.
updateTime	string (google-datetime)	Output only. Time at which the automation was updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.
annotations	object	Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
createTime	string (google-datetime)	Output only. Time at which the automation was created.
description	string	Optional. Description of the Automation. Max length is 255 characters.
etag	string	Optional. The weak etag of the Automation resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
rules	array	Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
selector	object	Required. Selected resources to which the automation will be applied. (id: AutomationResourceSelector)
serviceAccount	string	Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
suspended	boolean	Optional. When Suspended, automation is deactivated from execution.
uid	string	Output only. Unique identifier of the Automation.
updateTime	string (google-datetime)	Output only. Time at which the automation was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deliveryPipelinesId, automationsId		Gets details of a single Automation.
list	select	projectsId, locationsId, deliveryPipelinesId	pageSize, pageToken, filter, orderBy	Lists Automations in a given project and location.
create	insert	projectsId, locationsId, deliveryPipelinesId	automationId, requestId, validateOnly	Creates a new Automation in a given project and location.
patch	update	projectsId, locationsId, deliveryPipelinesId, automationsId	updateMask, requestId, allowMissing, validateOnly	Updates the parameters of a single Automation resource.
delete	delete	projectsId, locationsId, deliveryPipelinesId, automationsId	requestId, allowMissing, validateOnly, etag	Deletes a single Automation resource.

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
automationsId	string
deliveryPipelinesId	string
locationsId	string
projectsId	string
allowMissing	boolean
automationId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets details of a single Automation.

SELECT
name,
annotations,
createTime,
description,
etag,
labels,
rules,
selector,
serviceAccount,
suspended,
uid,
updateTime
FROM google.clouddeploy.automations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND automationsId = '{{ automationsId }}' -- required;

list

Lists Automations in a given project and location.

SELECT
name,
annotations,
createTime,
description,
etag,
labels,
rules,
selector,
serviceAccount,
suspended,
uid,
updateTime
FROM google.clouddeploy.automations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Automation in a given project and location.

INSERT INTO google.clouddeploy.automations (
data__description,
data__annotations,
data__labels,
data__etag,
data__suspended,
data__serviceAccount,
data__selector,
data__rules,
projectsId,
locationsId,
deliveryPipelinesId,
automationId,
requestId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
{{ suspended }},
'{{ serviceAccount }}',
'{{ selector }}',
'{{ rules }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deliveryPipelinesId }}',
'{{ automationId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: automations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the automations resource.
    - name: locationsId
      value: string
      description: Required parameter for the automations resource.
    - name: deliveryPipelinesId
      value: string
      description: Required parameter for the automations resource.
    - name: description
      value: string
      description: >
        Optional. Description of the `Automation`. Max length is 255 characters.
        
    - name: annotations
      value: object
      description: >
        Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
        
    - name: labels
      value: object
      description: >
        Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
        
    - name: etag
      value: string
      description: >
        Optional. The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
        
    - name: suspended
      value: boolean
      description: >
        Optional. When Suspended, automation is deactivated from execution.
        
    - name: serviceAccount
      value: string
      description: >
        Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
        
    - name: selector
      value: object
      description: >
        Required. Selected resources to which the automation will be applied.
        
    - name: rules
      value: array
      description: >
        Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
        
    - name: automationId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates the parameters of a single Automation resource.

UPDATE google.clouddeploy.automations
SET 
data__description = '{{ description }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__suspended = {{ suspended }},
data__serviceAccount = '{{ serviceAccount }}',
data__selector = '{{ selector }}',
data__rules = '{{ rules }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' --required
AND automationsId = '{{ automationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Automation resource.

DELETE FROM google.clouddeploy.automations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' --required
AND automationsId = '{{ automationsId }}' --required
AND requestId = '{{ requestId }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}';