Google Cloud Deploy V1 Client - Class CreateTargetRequest (1.4.0)

Version 1.4.0

• 2.0.0 (latest)
• 1.4.0
• 1.3.0
• 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 CreateTargetRequest.

The request object for CreateTarget.

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

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 Target must be created. The format is projects/{project_id}/locations/{location_name}.
↳ target_id	string Required. ID of the Target.
↳ target	Target Required. The Target 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 Target must be created.

The format is projects/{project_id}/locations/{location_name}.

Returns
Type	Description
string

setParent

Required. The parent collection in which the Target must be created.

The format is projects/{project_id}/locations/{location_name}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetId

Required. ID of the Target.

Returns
Type	Description
string

setTargetId

Required. ID of the Target.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTarget

Required. The Target to create.

Returns
Type	Description
Target|null

hasTarget

clearTarget

setTarget

Required. The Target to create.

Parameter
Name	Description
var	Target

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

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 Target must be created. The format is projects/{project_id}/locations/{location_name}. Please see CloudDeployClient::locationName() for help formatting this field.
target	Target Required. The Target to create.
targetId	string Required. ID of the Target.

Returns
Type	Description
CreateTargetRequest