automations

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

Overview

Name	automations
Type	Resource
Id	google.clouddeploy.automations

Fields

Name	Datatype	Description
name	string	Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.
description	string	Optional. Description of the Automation. Max length is 255 characters.
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	Output only. Time at which the automation was created.
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	AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.
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	Output only. Time at which the automation was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationsId, deliveryPipelinesId, locationsId, projectsId	Gets details of a single Automation.
list	SELECT	deliveryPipelinesId, locationsId, projectsId	Lists Automations in a given project and location.
create	INSERT	deliveryPipelinesId, locationsId, projectsId	Creates a new Automation in a given project and location.
delete	DELETE	automationsId, deliveryPipelinesId, locationsId, projectsId	Deletes a single Automation resource.
patch	UPDATE	automationsId, deliveryPipelinesId, locationsId, projectsId	Updates the parameters of a single Automation resource.

SELECT examples

Lists Automations in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new automations resource.

All Properties

/*+ create */
INSERT INTO google.clouddeploy.automations (
deliveryPipelinesId,
locationsId,
projectsId,
description,
annotations,
labels,
etag,
suspended,
serviceAccount,
selector,
rules
)
SELECT 
'{{ deliveryPipelinesId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
{{ suspended }},
'{{ serviceAccount }}',
'{{ selector }}',
'{{ rules }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: description
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: annotations
      value: object
    - name: labels
      value: object
    - name: etag
      value: string
    - name: suspended
      value: boolean
    - name: serviceAccount
      value: string
    - name: selector
      value:
        - name: targets
          value:
            - - name: id
                value: string
              - name: labels
                value: object
    - name: rules
      value:
        - - name: promoteReleaseRule
            value:
              - name: id
                value: string
              - name: wait
                value: string
              - name: destinationTargetId
                value: string
              - name: condition
                value:
                  - name: targetsPresentCondition
                    value:
                      - name: status
                        value: boolean
                      - name: missingTargets
                        value:
                          - string
                      - name: updateTime
                        value: string
              - name: destinationPhase
                value: string
          - name: advanceRolloutRule
            value:
              - name: id
                value: string
              - name: sourcePhases
                value:
                  - string
              - name: wait
                value: string
          - name: repairRolloutRule
            value:
              - name: id
                value: string
              - name: jobs
                value:
                  - string

UPDATE example

Updates a automations resource.

/*+ update */
UPDATE google.clouddeploy.automations
SET 
description = '{{ description }}',
annotations = '{{ annotations }}',
labels = '{{ labels }}',
etag = '{{ etag }}',
suspended = true|false,
serviceAccount = '{{ serviceAccount }}',
selector = '{{ selector }}',
rules = '{{ rules }}'
WHERE 
automationsId = '{{ automationsId }}'
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified automations resource.

/*+ delete */
DELETE FROM google.clouddeploy.automations
WHERE automationsId = '{{ automationsId }}'
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';