Reference documentation and code samples for the Google Cloud Dataproc Metastore V1alpha Client class DataprocMetastoreFederationClient.
Service Description: Configures and manages metastore federation services.
Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.
The Dataproc Metastore Federation API defines the following resource model:
- The service works with a collection of Google Cloud projects.
- Each project has a collection of available locations.
- Each location has a collection of federations.
- Dataproc Metastore Federations are resources with names of the
form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
try {
$formattedParent = $dataprocMetastoreFederationClient->locationName('[PROJECT]', '[LOCATION]');
$federationId = 'federation_id';
$federation = new Federation();
$operationResponse = $dataprocMetastoreFederationClient->createFederation($formattedParent, $federationId, $federation);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataprocMetastoreFederationClient->createFederation($formattedParent, $federationId, $federation);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataprocMetastoreFederationClient->resumeOperation($operationName, 'createFederation');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataprocMetastoreFederationClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Methods
federationName
Formats a string containing the fully-qualified path to represent a federation resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
federation |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted federation resource. |
locationName
Formats a string containing the fully-qualified path to represent a location resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted location resource. |
parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- federation: projects/{project}/locations/{location}/federations/{federation}
- location: projects/{project}/locations/{location}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array | An associative array from name component IDs to component values. |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createFederation
Creates a metastore federation in a project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the location in which to create a federation service, in the following form: |
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. |
federation |
Google\Cloud\Metastore\V1alpha\Federation
Required. The Metastore Federation to create. The |
optionalArgs |
array
Optional. |
↳ requestId |
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. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreFederationClient;
use Google\Cloud\Metastore\V1alpha\Federation;
use Google\Rpc\Status;
/**
* @param string $formattedParent 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
* {@see DataprocMetastoreFederationClient::locationName()} for help formatting this field.
* @param string $federationId 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.
*/
function create_federation_sample(string $formattedParent, string $federationId): void
{
// Create a client.
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
// Prepare any non-scalar elements to be passed along with the request.
$federation = new Federation();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreFederationClient->createFederation(
$formattedParent,
$federationId,
$federation
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Federation $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataprocMetastoreFederationClient::locationName('[PROJECT]', '[LOCATION]');
$federationId = '[FEDERATION_ID]';
create_federation_sample($formattedParent, $federationId);
}
deleteFederation
Deletes a single federation.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the metastore federation to delete, in the following form: |
optionalArgs |
array
Optional. |
↳ requestId |
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. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreFederationClient;
use Google\Rpc\Status;
/**
* @param string $formattedName 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
* {@see DataprocMetastoreFederationClient::federationName()} for help formatting this field.
*/
function delete_federation_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreFederationClient->deleteFederation($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataprocMetastoreFederationClient::federationName(
'[PROJECT]',
'[LOCATION]',
'[FEDERATION]'
);
delete_federation_sample($formattedName);
}
getFederation
Gets the details of a single federation.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the metastore federation to retrieve, in the following form: |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1alpha\Federation | |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreFederationClient;
use Google\Cloud\Metastore\V1alpha\Federation;
/**
* @param string $formattedName The relative resource name of the metastore federation to retrieve,
* in the following form:
*
* `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. Please see
* {@see DataprocMetastoreFederationClient::federationName()} for help formatting this field.
*/
function get_federation_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
// Call the API and handle any network failures.
try {
/** @var Federation $response */
$response = $dataprocMetastoreFederationClient->getFederation($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataprocMetastoreFederationClient::federationName(
'[PROJECT]',
'[LOCATION]',
'[FEDERATION]'
);
get_federation_sample($formattedName);
}
listFederations
Lists federations in a project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the location of metastore federations to list, in the following form: |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. The filter to apply to list results. |
↳ orderBy |
string
Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreFederationClient;
use Google\Cloud\Metastore\V1alpha\Federation;
/**
* @param string $formattedParent The relative resource name of the location of metastore federations
* to list, in the following form:
* `projects/{project_number}/locations/{location_id}`. Please see
* {@see DataprocMetastoreFederationClient::locationName()} for help formatting this field.
*/
function list_federations_sample(string $formattedParent): void
{
// Create a client.
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreFederationClient->listFederations($formattedParent);
/** @var Federation $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataprocMetastoreFederationClient::locationName('[PROJECT]', '[LOCATION]');
list_federations_sample($formattedParent);
}
updateFederation
Updates the fields of a federation.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the |
federation |
Google\Cloud\Metastore\V1alpha\Federation
Required. The metastore federation to update. The server only merges fields in the service if they are specified in |
optionalArgs |
array
Optional. |
↳ requestId |
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. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreFederationClient;
use Google\Cloud\Metastore\V1alpha\Federation;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_federation_sample(): void
{
// Create a client.
$dataprocMetastoreFederationClient = new DataprocMetastoreFederationClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$federation = new Federation();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreFederationClient->updateFederation($updateMask, $federation);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Federation $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.cloud.metastore.v1alpha.DataprocMetastoreFederation'The name of the service.
SERVICE_ADDRESS
Value: 'metastore.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.