Google Cloud Deploy V1 Client - Class CreateAutomationRequest (0.17.0)

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

The request object for CreateAutomation.

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

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 `Automation` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`↳ automation_id`	`string` Required. ID of the `Automation`.
`↳ automation`	`Google\Cloud\Deploy\V1\Automation` Required. The `Automation` 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 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).
`↳ 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 Automation should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAutomationId

Required. ID of the Automation.

Returns
Type	Description
`string`

setAutomationId

Required. ID of the Automation.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAutomation

Required. The Automation to create.

Returns
Type	Description
`Google\Cloud\Deploy\V1\Automation\|null`

hasAutomation

clearAutomation

setAutomation

Required. The Automation to create.

Parameter
Name	Description
`var`	`Google\Cloud\Deploy\V1\Automation`

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

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 `Automation` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. Please see Google\Cloud\Deploy\V1\CloudDeployClient::deliveryPipelineName() for help formatting this field.
`automation`	`Google\Cloud\Deploy\V1\Automation` Required. The `Automation` to create.
`automationId`	`string` Required. ID of the `Automation`.

Returns
Type	Description
`Google\Cloud\Deploy\V1\CreateAutomationRequest`