delivery_pipelines

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

Overview

Name	delivery_pipelines
Type	Resource
Id	google.clouddeploy.delivery_pipelines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the DeliveryPipeline. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. The deliveryPipeline component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
annotations	object	Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
condition	object	Output only. Information around the state of the Delivery Pipeline. (id: PipelineCondition)
createTime	string (google-datetime)	Output only. Time at which the pipeline was created.
description	string	Optional. Description of the DeliveryPipeline. Max length is 255 characters.
etag	string	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 <= 128 bytes.
serialPipeline	object	Optional. SerialPipeline defines a sequential set of stages for a DeliveryPipeline. (id: SerialPipeline)
suspended	boolean	Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
uid	string	Output only. Unique identifier of the DeliveryPipeline.
updateTime	string (google-datetime)	Output only. Most recent time at which the pipeline was updated.

list

Name	Datatype	Description
name	string	Identifier. Name of the DeliveryPipeline. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. The deliveryPipeline component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
annotations	object	Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
condition	object	Output only. Information around the state of the Delivery Pipeline. (id: PipelineCondition)
createTime	string (google-datetime)	Output only. Time at which the pipeline was created.
description	string	Optional. Description of the DeliveryPipeline. Max length is 255 characters.
etag	string	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 <= 128 bytes.
serialPipeline	object	Optional. SerialPipeline defines a sequential set of stages for a DeliveryPipeline. (id: SerialPipeline)
suspended	boolean	Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
uid	string	Output only. Unique identifier of the DeliveryPipeline.
updateTime	string (google-datetime)	Output only. Most recent time at which the pipeline was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deliveryPipelinesId		Gets details of a single DeliveryPipeline.
list	select	projectsId, locationsId	filter, pageToken, pageSize, orderBy	Lists DeliveryPipelines in a given project and location.
create	insert	projectsId, locationsId	requestId, validateOnly, deliveryPipelineId	Creates a new DeliveryPipeline in a given project and location.
patch	update	projectsId, locationsId, deliveryPipelinesId	updateMask, validateOnly, requestId, allowMissing	Updates the parameters of a single DeliveryPipeline.
delete	delete	projectsId, locationsId, deliveryPipelinesId	requestId, force, allowMissing, etag, validateOnly	Deletes a single DeliveryPipeline.
rollback_target	exec	projectsId, locationsId, deliveryPipelinesId		Creates a Rollout to roll back the specified target.

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

SELECT examples

get

Gets details of a single DeliveryPipeline.

SELECT
name,
annotations,
condition,
createTime,
description,
etag,
labels,
serialPipeline,
suspended,
uid,
updateTime
FROM google.clouddeploy.delivery_pipelines
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
;

list

Lists DeliveryPipelines in a given project and location.

SELECT
name,
annotations,
condition,
createTime,
description,
etag,
labels,
serialPipeline,
suspended,
uid,
updateTime
FROM google.clouddeploy.delivery_pipelines
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new DeliveryPipeline in a given project and location.

INSERT INTO google.clouddeploy.delivery_pipelines (
data__suspended,
data__description,
data__etag,
data__annotations,
data__serialPipeline,
data__labels,
data__name,
projectsId,
locationsId,
requestId,
validateOnly,
deliveryPipelineId
)
SELECT 
{{ suspended }},
'{{ description }}',
'{{ etag }}',
'{{ annotations }}',
'{{ serialPipeline }}',
'{{ labels }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ validateOnly }}',
'{{ deliveryPipelineId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: delivery_pipelines
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the delivery_pipelines resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the delivery_pipelines resource.
  - name: suspended
    value: {{ suspended }}
    description: |
      Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the `DeliveryPipeline`. Max length is 255 characters.
  - name: etag
    value: "{{ etag }}"
    description: |
      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: annotations
    value: "{{ annotations }}"
    description: |
      Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
  - name: serialPipeline
    description: |
      Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
    value:
      stages:
        - strategy:
            standard:
              verify: {{ verify }}
              predeploy:
                actions: "{{ actions }}"
                tasks: "{{ tasks }}"
              analysis:
                googleCloud: "{{ googleCloud }}"
                customChecks: "{{ customChecks }}"
                duration: "{{ duration }}"
              postdeploy:
                actions: "{{ actions }}"
                tasks: "{{ tasks }}"
              verifyConfig:
                tasks: "{{ tasks }}"
            canary:
              runtimeConfig:
                kubernetes: "{{ kubernetes }}"
                cloudRun: "{{ cloudRun }}"
              canaryDeployment:
                analysis: "{{ analysis }}"
                predeploy: "{{ predeploy }}"
                verify: {{ verify }}
                verifyConfig: "{{ verifyConfig }}"
                percentages: "{{ percentages }}"
                postdeploy: "{{ postdeploy }}"
              customCanaryDeployment:
                phaseConfigs: "{{ phaseConfigs }}"
          profiles: "{{ profiles }}"
          targetId: "{{ targetId }}"
          deployParameters: "{{ deployParameters }}"
  - name: labels
    value: "{{ labels }}"
    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 <= 128 bytes.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: deliveryPipelineId
    value: "{{ deliveryPipelineId }}"

UPDATE examples

patch

Updates the parameters of a single DeliveryPipeline.

UPDATE google.clouddeploy.delivery_pipelines
SET 
data__suspended = {{ suspended }},
data__description = '{{ description }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__serialPipeline = '{{ serialPipeline }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single DeliveryPipeline.

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

Lifecycle Methods

rollback_target

Creates a Rollout to roll back the specified target.

EXEC google.clouddeploy.delivery_pipelines.rollback_target 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required 
@@json=
'{
"rolloutToRollBack": "{{ rolloutToRollBack }}", 
"releaseId": "{{ releaseId }}", 
"targetId": "{{ targetId }}", 
"rolloutId": "{{ rolloutId }}", 
"rollbackConfig": "{{ rollbackConfig }}", 
"validateOnly": {{ validateOnly }}, 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}'
;