Google Cloud Deploy V1 Client - Class DeleteCustomTargetTypeRequest (1.2.0)

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

The request object for DeleteCustomTargetType.

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.
↳ 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, then deleting an already deleted or non-existing CustomTargetType will succeed.
↳ validate_only bool

Optional. If set to true, the request is validated but no actual change is made.
↳ etag string

Optional. 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.

getName

Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

Returns
Type Description
string

setName

Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

Parameter
Name Description
var string
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, then deleting an already deleted or non-existing CustomTargetType will succeed.

Returns
Type Description
bool

setAllowMissing

Optional. If set to true, then deleting an already deleted or non-existing CustomTargetType will succeed.

Parameter
Name Description
var bool
Returns
Type Description
$this

getValidateOnly

Optional. If set to true, the request is validated but no actual change is made.

Returns
Type Description
bool

setValidateOnly

Optional. If set to true, the request is validated but no actual change is made.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEtag

Optional. 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.

Returns
Type Description
string

setEtag

Optional. 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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::customTargetTypeName() for help formatting this field.
Returns
Type Description
Google\Cloud\Deploy\V1\DeleteCustomTargetTypeRequest