Google Cloud Deploy V1 Client - Class UpdateDeliveryPipelineRequest (2.0.0)

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

The request object for UpdateDeliveryPipeline.

Generated from protobuf message google.cloud.deploy.v1.UpdateDeliveryPipelineRequest

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ update_mask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.
↳ delivery_pipeline Google\Cloud\Deploy\V1\DeliveryPipeline

Required. The DeliveryPipeline to update.
↳ request_id string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ allow_missing bool

Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.
↳ validate_only bool

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getDeliveryPipeline

Required. The DeliveryPipeline to update.

Returns
Type Description
Google\Cloud\Deploy\V1\DeliveryPipeline|null

hasDeliveryPipeline

clearDeliveryPipeline

setDeliveryPipeline

Required. The DeliveryPipeline to update.

Parameter
Name Description
var Google\Cloud\Deploy\V1\DeliveryPipeline
Returns
Type Description
$this

getRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

getAllowMissing

Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.

Returns
Type Description
bool

setAllowMissing

Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.

Parameter
Name Description
var bool
Returns
Type Description
$this

getValidateOnly

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Returns
Type Description
bool

setValidateOnly

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
deliveryPipeline Google\Cloud\Deploy\V1\DeliveryPipeline

Required. The DeliveryPipeline to update.
updateMask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.
Returns
Type Description
Google\Cloud\Deploy\V1\UpdateDeliveryPipelineRequest