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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ serial_pipeline
Google\Cloud\Deploy\V1\SerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline
.
↳ condition
Google\Cloud\Deploy\V1\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])?
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])?
var
string
$this
getUid
Output only. Unique identifier of the DeliveryPipeline
.
string
setUid
Output only. Unique identifier of the DeliveryPipeline
.
var
string
$this
getDescription
Description of the DeliveryPipeline
. Max length is 255 characters.
string
setDescription
Description of the DeliveryPipeline
. Max length is 255 characters.
var
string
$this
getAnnotations
User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
setAnnotations
User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
$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.
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.
$this
getCreateTime
Output only. Time at which the pipeline was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the pipeline was created.
$this
getUpdateTime
Output only. Most recent time at which the pipeline was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Most recent time at which the pipeline was updated.
$this
getSerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline
.
hasSerialPipeline
setSerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline
.
$this
getCondition
Output only. Information around the state of the Delivery Pipeline.
hasCondition
clearCondition
setCondition
Output only. Information around the state of the Delivery Pipeline.
$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.
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.
var
string
$this
getSuspended
When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
bool
setSuspended
When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
var
bool
$this
getPipeline
string
