Google Cloud Deploy V1 Client - Class CreateDeliveryPipelineRequest (0.16.0)

Version 0.16.0

• 2.0.0 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.19.1
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.4

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

The request object for CreateDeliveryPipeline.

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.
↳ delivery_pipeline_id	string Required. ID of the DeliveryPipeline.
↳ delivery_pipeline	Google\Cloud\Deploy\V1\DeliveryPipeline Required. The DeliveryPipeline to create.
↳ 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).
↳ 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.

getParent

Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.

Returns
Type	Description
string

setParent

Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeliveryPipelineId

Required. ID of the DeliveryPipeline.

Returns
Type	Description
string

setDeliveryPipelineId

Required. ID of the DeliveryPipeline.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeliveryPipeline

Required. The DeliveryPipeline to create.

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

hasDeliveryPipeline

clearDeliveryPipeline

setDeliveryPipeline

Required. The DeliveryPipeline to create.

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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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

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
parent	string Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::locationName() for help formatting this field.
deliveryPipeline	Google\Cloud\Deploy\V1\DeliveryPipeline Required. The DeliveryPipeline to create.
deliveryPipelineId	string Required. ID of the DeliveryPipeline.

Returns
Type	Description
Google\Cloud\Deploy\V1\CreateDeliveryPipelineRequest