Google Cloud Gke Hub V1 Client - Class DeleteMembershipRequest (0.6.3)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class DeleteMembershipRequest.

Request message for GkeHub.DeleteMembership method.

Generated from protobuf message google.cloud.gkehub.v1.DeleteMembershipRequest

Methods

build

Parameter
NameDescription
name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*. Please see {@see \Google\Cloud\GkeHub\V1\GkeHubClient::membershipName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeHub\V1\DeleteMembershipRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

↳ 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 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).

↳ force bool

Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.

getName

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns
TypeDescription
string

setName

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$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 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
TypeDescription
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 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
NameDescription
var string
Returns
TypeDescription
$this

getForce

Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.

Returns
TypeDescription
bool

setForce

Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this