Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeliveryPipeline.
ADeliveryPipelineresource in the Cloud Deploy API.
ADeliveryPipelinedefines a pipeline through which a Skaffold
configuration can progress.
Generated from protobuf messagegoogle.cloud.deploy.v1.DeliveryPipeline
Namespace
Google \ Cloud \ Deploy \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. Name of theDeliveryPipeline. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. ThedeliveryPipelinecomponent must match[a-z]([a-z0-9-]{0,61}[a-z0-9])?
↳ uid
string
Output only. Unique identifier of theDeliveryPipeline.
↳ description
string
Description of theDeliveryPipeline. Max length is 255 characters.
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.
Output only. Information around the state of the Delivery Pipeline.
↳ 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.
↳ suspended
bool
When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
getName
Optional. Name of theDeliveryPipeline. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}.
ThedeliveryPipelinecomponent must match[a-z]([a-z0-9-]{0,61}[a-z0-9])?
Returns
Type
Description
string
setName
Optional. Name of theDeliveryPipeline. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}.
ThedeliveryPipelinecomponent must match[a-z]([a-z0-9-]{0,61}[a-z0-9])?
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUid
Output only. Unique identifier of theDeliveryPipeline.
Returns
Type
Description
string
setUid
Output only. Unique identifier of theDeliveryPipeline.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Description of theDeliveryPipeline. Max length is 255 characters.
Returns
Type
Description
string
setDescription
Description of theDeliveryPipeline. Max length is 255 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAnnotations
User annotations. These attributes can only be set and used by the
user, and not by Cloud Deploy.
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.
Returns
Type
Description
string
setEtag
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSuspended
When suspended, no new releases or rollouts can be created,
but in-progress ones will complete.
Returns
Type
Description
bool
setSuspended
When suspended, no new releases or rollouts can be created,
but in-progress ones will complete.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class DeliveryPipeline (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.DeliveryPipeline)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.DeliveryPipeline)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.DeliveryPipeline)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.DeliveryPipeline)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.DeliveryPipeline)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.DeliveryPipeline)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.DeliveryPipeline)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.DeliveryPipeline)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.DeliveryPipeline)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.DeliveryPipeline)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.DeliveryPipeline)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.DeliveryPipeline)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.DeliveryPipeline)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.DeliveryPipeline)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.DeliveryPipeline)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.DeliveryPipeline)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.DeliveryPipeline)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.DeliveryPipeline)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.DeliveryPipeline)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.DeliveryPipeline)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.DeliveryPipeline)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.DeliveryPipeline)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.DeliveryPipeline)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.DeliveryPipeline) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class DeliveryPipeline.\n\nA `DeliveryPipeline` resource in the Cloud Deploy API.\n\nA `DeliveryPipeline` defines a pipeline through which a Skaffold\nconfiguration can progress.\n\nGenerated from protobuf message `google.cloud.deploy.v1.DeliveryPipeline`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOptional. Name of the `DeliveryPipeline`. Format is\n`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`.\n\nThe `deliveryPipeline` component must match\n`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`\n\n### setName\n\nOptional. Name of the `DeliveryPipeline`. Format is\n`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`.\n\nThe `deliveryPipeline` component must match\n`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`\n\n### getUid\n\nOutput only. Unique identifier of the `DeliveryPipeline`.\n\n### setUid\n\nOutput only. Unique identifier of the `DeliveryPipeline`.\n\n### getDescription\n\nDescription of the `DeliveryPipeline`. Max length is 255 characters.\n\n### setDescription\n\nDescription of the `DeliveryPipeline`. Max length is 255 characters.\n\n### getAnnotations\n\nUser annotations. These attributes can only be set and used by the\nuser, and not by Cloud Deploy.\n\n### setAnnotations\n\nUser annotations. These attributes can only be set and used by the\nuser, and not by Cloud Deploy.\n\n### getLabels\n\nLabels are attributes that can be set and used by both the\nuser and by Cloud Deploy. Labels must meet the following constraints:\n\n- Keys and values can contain only lowercase letters, numeric characters,\n underscores, and dashes.\n\n- All characters must use UTF-8 encoding, and international characters are\n allowed.\n\n- Keys must start with a lowercase letter or international character.\n- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \\\u003c= 128 bytes.\n\n### setLabels\n\nLabels are attributes that can be set and used by both the\nuser and by Cloud Deploy. Labels must meet the following constraints:\n\n- Keys and values can contain only lowercase letters, numeric characters,\n underscores, and dashes.\n\n- All characters must use UTF-8 encoding, and international characters are\n allowed.\n\n- Keys must start with a lowercase letter or international character.\n- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \\\u003c= 128 bytes.\n\n### getCreateTime\n\nOutput only. Time at which the pipeline was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Time at which the pipeline was created.\n\n### getUpdateTime\n\nOutput only. Most recent time at which the pipeline was updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Most recent time at which the pipeline was updated.\n\n### getSerialPipeline\n\nSerialPipeline defines a sequential set of stages for a\n`DeliveryPipeline`.\n\n### hasSerialPipeline\n\n### setSerialPipeline\n\nSerialPipeline defines a sequential set of stages for a\n`DeliveryPipeline`.\n\n### getCondition\n\nOutput only. Information around the state of the Delivery Pipeline.\n\n### hasCondition\n\n### clearCondition\n\n### setCondition\n\nOutput only. Information around the state of the Delivery Pipeline.\n\n### getEtag\n\nThis checksum is computed by the server based on the value of other\nfields, and may be sent on update and delete requests to ensure the\nclient has an up-to-date value before proceeding.\n\n### setEtag\n\nThis checksum is computed by the server based on the value of other\nfields, and may be sent on update and delete requests to ensure the\nclient has an up-to-date value before proceeding.\n\n### getSuspended\n\nWhen suspended, no new releases or rollouts can be created,\nbut in-progress ones will complete.\n\n### setSuspended\n\nWhen suspended, no new releases or rollouts can be created,\nbut in-progress ones will complete.\n\n### getPipeline"]]
