Google Cloud Saas Platform Saas Service Mgmt V1 Client - Class DeleteRolloutKindRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class DeleteRolloutKindRequest.

The request structure for the DeleteRolloutKind method.

Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.DeleteRolloutKindRequest

Namespace

Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the resource within a service.

↳ etag string

The etag known to the client for the expected state of the rollout kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

↳ validate_only bool

If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

↳ request_id string

An optional 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).

getName

Required. The resource name of the resource within a service.

Returns
Type Description
string

setName

Required. The resource name of the resource within a service.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

The etag known to the client for the expected state of the rollout kind.

This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

Returns
Type Description
string

setEtag

The etag known to the client for the expected state of the rollout kind.

This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

Returns
Type Description
bool

setValidateOnly

If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRequestId

An optional 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

An optional 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

static::build

Parameter
Name Description
name string

Required. The resource name of the resource within a service. Please see SaasRolloutsClient::rolloutKindName() for help formatting this field.

Returns
Type Description
DeleteRolloutKindRequest