Google Cloud Dataproc Metastore V1 Client - Class CreateFederationRequest (0.11.5)

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

Request message for CreateFederation.

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

Namespace

Google \ Cloud \ Metastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The relative resource name of the location in which to create a federation service, in the following form: projects/{project_number}/locations/{location_id}.
↳ federation_id string

Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
↳ federation Google\Cloud\Metastore\V1\Federation

Required. The Metastore Federation to create. The name field is ignored. The ID of the created metastore federation must be provided in the request's federation_id field.
↳ 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.

getParent

Required. The relative resource name of the location in which to create a federation service, in the following form: projects/{project_number}/locations/{location_id}.

Returns
Type Description
string

setParent

Required. The relative resource name of the location in which to create a federation service, in the following form: projects/{project_number}/locations/{location_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getFederationId

Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.

This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

Returns
Type Description
string

setFederationId

Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.

This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

Parameter
Name Description
var string
Returns
Type Description
$this

getFederation

Required. The Metastore Federation to create. The name field is ignored. The ID of the created metastore federation must be provided in the request's federation_id field.

Returns
Type Description
Google\Cloud\Metastore\V1\Federation|null

hasFederation

clearFederation

setFederation

Required. The Metastore Federation to create. The name field is ignored. The ID of the created metastore federation must be provided in the request's federation_id field.

Parameter
Name Description
var Google\Cloud\Metastore\V1\Federation
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

Parameters
Name Description
parent string

Required. The relative resource name of the location in which to create a federation service, in the following form:

projects/{project_number}/locations/{location_id}. Please see Google\Cloud\Metastore\V1\DataprocMetastoreFederationClient::locationName() for help formatting this field.
federation Google\Cloud\Metastore\V1\Federation

Required. The Metastore Federation to create. The name field is ignored. The ID of the created metastore federation must be provided in the request's federation_id field.
federationId string

Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.

This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
Returns
Type Description
Google\Cloud\Metastore\V1\CreateFederationRequest