Google Cloud Deploy V1 Client - Class DeliveryPipeline (1.5.1)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeliveryPipeline.

A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Generated from protobuf message google.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 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])?`
`↳ uid`	`string` Output only. Unique identifier of the `DeliveryPipeline`.
`↳ description`	`string` Description of the `DeliveryPipeline`. Max length is 255 characters.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` 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.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time at which the pipeline was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Most recent time at which the pipeline was updated.
`↳ serial_pipeline`	`SerialPipeline` SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
`↳ condition`	`PipelineCondition` 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 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])?

Returns
Type	Description
`string`

setName

Optional. 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])?

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Unique identifier of the DeliveryPipeline.

Returns
Type	Description
`string`

setUid

Output only. Unique identifier of the DeliveryPipeline.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Description of the DeliveryPipeline. Max length is 255 characters.

Returns
Type	Description
`string`

setDescription

Description of the DeliveryPipeline. 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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAnnotations

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getLabels

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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time at which the pipeline was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the pipeline was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Most recent time at which the pipeline was updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Most recent time at which the pipeline was updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getSerialPipeline

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Returns
Type	Description
`SerialPipeline\|null`

hasSerialPipeline

setSerialPipeline

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Parameter
Name	Description
`var`	`SerialPipeline`

Returns
Type	Description
`$this`

getCondition

Output only. Information around the state of the Delivery Pipeline.

Returns
Type	Description
`PipelineCondition\|null`

hasCondition

clearCondition

setCondition

Output only. Information around the state of the Delivery Pipeline.

Parameter
Name	Description
`var`	`PipelineCondition`

Returns
Type	Description
`$this`

getEtag

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPipeline

Returns
Type	Description
`string`