Skip to main content

delivery_pipelines

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

Overview​

Namedelivery_pipelines
TypeResource
Idgoogle.clouddeploy.delivery_pipelines

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. 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])?
annotationsobjectOptional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
conditionobjectOutput only. Information around the state of the Delivery Pipeline. (id: PipelineCondition)
createTimestring (google-datetime)Output only. Time at which the pipeline was created.
descriptionstringOptional. Description of the DeliveryPipeline. Max length is 255 characters.
etagstringThis 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.
labelsobjectLabels 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.
serialPipelineobjectOptional. SerialPipeline defines a sequential set of stages for a DeliveryPipeline. (id: SerialPipeline)
suspendedbooleanOptional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
uidstringOutput only. Unique identifier of the DeliveryPipeline.
updateTimestring (google-datetime)Output only. Most recent time at which the pipeline was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, deliveryPipelinesIdGets details of a single DeliveryPipeline.
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists DeliveryPipelines in a given project and location.
createinsertprojectsId, locationsIddeliveryPipelineId, requestId, validateOnlyCreates a new DeliveryPipeline in a given project and location.
patchupdateprojectsId, locationsId, deliveryPipelinesIdupdateMask, requestId, allowMissing, validateOnlyUpdates the parameters of a single DeliveryPipeline.
deletedeleteprojectsId, locationsId, deliveryPipelinesIdrequestId, allowMissing, validateOnly, force, etagDeletes a single DeliveryPipeline.
rollback_targetexecprojectsId, locationsId, deliveryPipelinesIdCreates 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.

NameDatatypeDescription
deliveryPipelinesIdstring
locationsIdstring
projectsIdstring
allowMissingboolean
deliveryPipelineIdstring
etagstring
filterstring
forceboolean
orderBystring
pageSizeinteger (int32)
pageTokenstring
requestIdstring
updateMaskstring (google-fieldmask)
validateOnlyboolean

SELECT examples​

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;

INSERT examples​

Creates a new DeliveryPipeline in a given project and location.

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

UPDATE examples​

Updates the parameters of a single DeliveryPipeline.

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

DELETE examples​

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 allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND force = '{{ force }}'
AND etag = '{{ etag }}';

Lifecycle Methods​

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=
'{
"targetId": "{{ targetId }}", 
"rolloutId": "{{ rolloutId }}", 
"releaseId": "{{ releaseId }}", 
"rolloutToRollBack": "{{ rolloutToRollBack }}", 
"rollbackConfig": "{{ rollbackConfig }}", 
"validateOnly": {{ validateOnly }}, 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';