Google Cloud Dataproc Metastore V1 Client - Class DeleteFederationRequest (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class DeleteFederationRequest.

Request message for DeleteFederation.

Generated from protobuf message google.cloud.metastore.v1.DeleteFederationRequest

Namespace

Google \ Cloud \ Metastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The relative resource name of the metastore federation to delete, in the following form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.
↳ request_id string

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

getName

Required. The relative resource name of the metastore federation to delete, in the following form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

Returns
Type Description
string

setName

Required. The relative resource name of the metastore federation to delete, in the following form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Returns
Type Description
string

setRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The relative resource name of the metastore federation to delete, in the following form:

projects/{project_number}/locations/{location_id}/federations/{federation_id}. Please see Google\Cloud\Metastore\V1\DataprocMetastoreFederationClient::federationName() for help formatting this field.
Returns
Type Description
Google\Cloud\Metastore\V1\DeleteFederationRequest