Reference documentation and code samples for the Google Cloud Dataproc Metastore V1alpha Client class DataprocMetastoreClient.
Service Description: Configures and manages metastore services.
Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.
The Dataproc Metastore API defines the following resource model:
- The service works with a collection of Google Cloud projects, named:
/projects/* - Each project has a collection of available locations, named:
/locations/*(a location must refer to a Google Cloudregion) - Each location has a collection of services, named:
/services/* - Dataproc Metastore services are resources with names of the form:
/projects/{project_number}/locations/{location_id}/services/{service_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:
$dataprocMetastoreClient = new DataprocMetastoreClient();
try {
$formattedService = $dataprocMetastoreClient->serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$resourceName = 'resource_name';
$locationUri = 'location_uri';
$operationResponse = $dataprocMetastoreClient->alterMetadataResourceLocation($formattedService, $resourceName, $locationUri);
$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 = $dataprocMetastoreClient->alterMetadataResourceLocation($formattedService, $resourceName, $locationUri);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataprocMetastoreClient->resumeOperation($operationName, 'alterMetadataResourceLocation');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataprocMetastoreClient->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.
Namespace
Google \ Cloud \ Metastore \ V1alphaMethods
__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 Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper 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 Google\ApiCore\CredentialsWrapper::build() . |
↳ 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 Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() 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. |
alterMetadataResourceLocation
Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
| Parameters | |
|---|---|
| Name | Description |
service |
string
Required. The relative resource name of the metastore service to mutate metadata, in the following format:
|
resourceName |
string
Required. The relative metadata resource name in the following format.
|
locationUri |
string
Required. The new location URI for the metadata resource. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\AlterMetadataResourceLocationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Rpc\Status;
/**
* @param string $formattedService The relative resource name of the metastore service to mutate
* metadata, in the following format:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $resourceName The relative metadata resource name in the following format.
*
* `databases/{database_id}`
* or
* `databases/{database_id}/tables/{table_id}`
* or
* `databases/{database_id}/tables/{table_id}/partitions/{partition_id}`
* @param string $locationUri The new location URI for the metadata resource.
*/
function alter_metadata_resource_location_sample(
string $formattedService,
string $resourceName,
string $locationUri
): void {
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->alterMetadataResourceLocation(
$formattedService,
$resourceName,
$locationUri
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AlterMetadataResourceLocationResponse $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());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$formattedService = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$resourceName = '[RESOURCE_NAME]';
$locationUri = '[LOCATION_URI]';
alter_metadata_resource_location_sample($formattedService, $resourceName, $locationUri);
}
createBackup
Creates a new backup in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the service in which to create a backup of the following form:
|
backupId |
string
Required. The ID of the backup, which is used as the final component of the backup's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
backup |
Google\Cloud\Metastore\V1alpha\Backup
Required. The backup 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\Backup;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The relative resource name of the service in which to create a
* backup of the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $backupId The ID of the backup, which is used as the final component of the
* backup's name.
*
* This value must be between 1 and 64 characters long, begin with a letter,
* end with a letter or number, and consist of alpha-numeric ASCII characters
* or hyphens.
*/
function create_backup_sample(string $formattedParent, string $backupId): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$backup = new Backup();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createBackup($formattedParent, $backupId, $backup);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Backup $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$backupId = '[BACKUP_ID]';
create_backup_sample($formattedParent, $backupId);
}
createMetadataImport
Creates a new MetadataImport in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the service in which to create a metastore import, in the following form:
|
metadataImportId |
string
Required. The ID of the metadata import, which is used as the final component of the metadata import's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
metadataImport |
Google\Cloud\Metastore\V1alpha\MetadataImport
Required. The metadata import 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MetadataImport;
use Google\Rpc\Status;
/**
* @param string $formattedParent The relative resource name of the service in which to create a
* metastore import, in the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $metadataImportId The ID of the metadata import, which is used as the final
* component of the metadata import's name.
*
* This value must be between 1 and 64 characters long, begin with a letter,
* end with a letter or number, and consist of alpha-numeric ASCII characters
* or hyphens.
*/
function create_metadata_import_sample(string $formattedParent, string $metadataImportId): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$metadataImport = new MetadataImport();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createMetadataImport(
$formattedParent,
$metadataImportId,
$metadataImport
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MetadataImport $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$metadataImportId = '[METADATA_IMPORT_ID]';
create_metadata_import_sample($formattedParent, $metadataImportId);
}
createService
Creates a metastore service in a project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the location in which to create a metastore service, in the following form:
|
serviceId |
string
Required. The ID of the metastore service, which is used as the final component of the metastore service'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. |
service |
Google\Cloud\Metastore\V1alpha\Service
Required. The Metastore service 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\Service;
use Google\Rpc\Status;
/**
* @param string $formattedParent The relative resource name of the location in which to create a
* metastore service, in the following form:
*
* `projects/{project_number}/locations/{location_id}`. Please see
* {@see DataprocMetastoreClient::locationName()} for help formatting this field.
* @param string $serviceId The ID of the metastore service, which is used as the final
* component of the metastore service'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_service_sample(string $formattedParent, string $serviceId): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$service = new Service();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createService($formattedParent, $serviceId, $service);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Service $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::locationName('[PROJECT]', '[LOCATION]');
$serviceId = '[SERVICE_ID]';
create_service_sample($formattedParent, $serviceId);
}
deleteBackup
Deletes a single backup.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the backup 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The relative resource name of the backup to delete, in the
* following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. Please see
* {@see DataprocMetastoreClient::backupName()} for help formatting this field.
*/
function delete_backup_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->deleteBackup($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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE]',
'[BACKUP]'
);
delete_backup_sample($formattedName);
}
deleteService
Deletes a single service.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the metastore service 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The relative resource name of the metastore service to delete, in
* the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
*/
function delete_service_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->deleteService($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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
delete_service_sample($formattedName);
}
exportMetadata
Exports metadata from a service.
| Parameters | |
|---|---|
| Name | Description |
service |
string
Required. The relative resource name of the metastore service to run export, in the following form:
|
optionalArgs |
array
Optional. |
↳ destinationGcsFolder |
string
A Cloud Storage URI of a folder, in the format |
↳ 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. |
↳ databaseDumpType |
int
Optional. The type of the database dump. If unspecified, defaults to |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MetadataExport;
use Google\Rpc\Status;
/**
* @param string $formattedService The relative resource name of the metastore service to run
* export, in the following form:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
*/
function export_metadata_sample(string $formattedService): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->exportMetadata($formattedService);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MetadataExport $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());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$formattedService = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
export_metadata_sample($formattedService);
}
getBackup
Gets details of a single backup.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the backup to retrieve, in the following form:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1alpha\Backup | |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1alpha\Backup;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* @param string $formattedName The relative resource name of the backup to retrieve, in the
* following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. Please see
* {@see DataprocMetastoreClient::backupName()} for help formatting this field.
*/
function get_backup_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var Backup $response */
$response = $dataprocMetastoreClient->getBackup($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE]',
'[BACKUP]'
);
get_backup_sample($formattedName);
}
getMetadataImport
Gets details of a single import.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the metadata import to retrieve, in the following form:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1alpha\MetadataImport | |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MetadataImport;
/**
* @param string $formattedName The relative resource name of the metadata import to retrieve, in
* the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}`. Please see
* {@see DataprocMetastoreClient::metadataImportName()} for help formatting this field.
*/
function get_metadata_import_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var MetadataImport $response */
$response = $dataprocMetastoreClient->getMetadataImport($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::metadataImportName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE]',
'[METADATA_IMPORT]'
);
get_metadata_import_sample($formattedName);
}
getService
Gets the details of a single service.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The relative resource name of the metastore service to retrieve, in the following form:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1alpha\Service | |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\Service;
/**
* @param string $formattedName The relative resource name of the metastore service to retrieve,
* in the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
*/
function get_service_sample(string $formattedName): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $dataprocMetastoreClient->getService($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
get_service_sample($formattedName);
}
listBackups
Lists backups in a service.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the service whose backups 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1alpha\Backup;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* @param string $formattedParent The relative resource name of the service whose backups to
* list, in the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}/backups`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
*/
function list_backups_sample(string $formattedParent): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listBackups($formattedParent);
/** @var Backup $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
list_backups_sample($formattedParent);
}
listMetadataImports
Lists imports in a service.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the service whose metadata imports 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MetadataImport;
/**
* @param string $formattedParent The relative resource name of the service whose metadata imports
* to list, in the following form:
*
* `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
*/
function list_metadata_imports_sample(string $formattedParent): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listMetadataImports($formattedParent);
/** @var MetadataImport $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
list_metadata_imports_sample($formattedParent);
}
listServices
Lists services in a project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The relative resource name of the location of metastore services 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\Service;
/**
* @param string $formattedParent The relative resource name of the location of metastore services
* to list, in the following form:
*
* `projects/{project_number}/locations/{location_id}`. Please see
* {@see DataprocMetastoreClient::locationName()} for help formatting this field.
*/
function list_services_sample(string $formattedParent): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listServices($formattedParent);
/** @var Service $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());
}
}
/**
* Helper to execute the sample.
*
* 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 = DataprocMetastoreClient::locationName('[PROJECT]', '[LOCATION]');
list_services_sample($formattedParent);
}
moveTableToDatabase
Move a table to another database.
| Parameters | |
|---|---|
| Name | Description |
service |
string
Required. The relative resource name of the metastore service to mutate metadata, in the following format:
|
tableName |
string
Required. The name of the table to be moved. |
dbName |
string
Required. The name of the database where the table resides. |
destinationDbName |
string
Required. The name of the database where the table should be moved. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MoveTableToDatabaseResponse;
use Google\Rpc\Status;
/**
* @param string $formattedService The relative resource name of the metastore service to mutate
* metadata, in the following format:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $tableName The name of the table to be moved.
* @param string $dbName The name of the database where the table resides.
* @param string $destinationDbName The name of the database where the table should be moved.
*/
function move_table_to_database_sample(
string $formattedService,
string $tableName,
string $dbName,
string $destinationDbName
): void {
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->moveTableToDatabase(
$formattedService,
$tableName,
$dbName,
$destinationDbName
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MoveTableToDatabaseResponse $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());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$formattedService = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$tableName = '[TABLE_NAME]';
$dbName = '[DB_NAME]';
$destinationDbName = '[DESTINATION_DB_NAME]';
move_table_to_database_sample($formattedService, $tableName, $dbName, $destinationDbName);
}
queryMetadata
Query DPMS metadata.
| Parameters | |
|---|---|
| Name | Description |
service |
string
Required. The relative resource name of the metastore service to query metadata, in the following format:
|
query |
string
Required. A read-only SQL query to execute against the metadata database. The query cannot change or mutate the data. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\QueryMetadataResponse;
use Google\Rpc\Status;
/**
* @param string $formattedService The relative resource name of the metastore service to query
* metadata, in the following format:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $query A read-only SQL query to execute against the metadata database.
* The query cannot change or mutate the data.
*/
function query_metadata_sample(string $formattedService, string $query): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->queryMetadata($formattedService, $query);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var QueryMetadataResponse $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());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$formattedService = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$query = '[QUERY]';
query_metadata_sample($formattedService, $query);
}
removeIamPolicy
Removes the attached IAM policies for a resource
| Parameters | |
|---|---|
| Name | Description |
resource |
string
Required. The relative resource name of the dataplane resource to remove IAM policy, in the following form:
|
optionalArgs |
array
Optional. |
↳ asynchronous |
bool
Optional. Removes IAM policy attached to database or table asynchronously when it is set. The default is false. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1alpha\RemoveIamPolicyResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\RemoveIamPolicyResponse;
/**
* @param string $resource The relative resource name of the dataplane resource to remove
* IAM policy, in the following form:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}`
* or
* `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}`.
*/
function remove_iam_policy_sample(string $resource): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var RemoveIamPolicyResponse $response */
$response = $dataprocMetastoreClient->removeIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$resource = '[RESOURCE]';
remove_iam_policy_sample($resource);
}
restoreService
Restores a service from a backup.
| Parameters | |
|---|---|
| Name | Description |
service |
string
Required. The relative resource name of the metastore service to run restore, in the following form:
|
backup |
string
Required. The relative resource name of the metastore service backup to restore from, in the following form:
|
optionalArgs |
array
Optional. |
↳ restoreType |
int
Optional. The type of restore. If unspecified, defaults to |
↳ 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\Restore;
use Google\Rpc\Status;
/**
* @param string $formattedService The relative resource name of the metastore service to run
* restore, in the following form:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}`. Please see
* {@see DataprocMetastoreClient::serviceName()} for help formatting this field.
* @param string $formattedBackup The relative resource name of the metastore service backup to
* restore from, in the following form:
*
* `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. Please see
* {@see DataprocMetastoreClient::backupName()} for help formatting this field.
*/
function restore_service_sample(string $formattedService, string $formattedBackup): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->restoreService($formattedService, $formattedBackup);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Restore $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());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$formattedService = DataprocMetastoreClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
$formattedBackup = DataprocMetastoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE]',
'[BACKUP]'
);
restore_service_sample($formattedService, $formattedBackup);
}
updateMetadataImport
Updates a single import.
Only the description field of MetadataImport is supported to be updated.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. A field mask used to specify the fields to be overwritten in the
metadata import resource by the update.
Fields specified in the |
metadataImport |
Google\Cloud\Metastore\V1alpha\MetadataImport
Required. The metadata import to update. The server only merges fields
in the import if they are specified in The metadata import's |
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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\MetadataImport;
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_metadata_import_sample(): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$metadataImport = new MetadataImport();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->updateMetadataImport($updateMask, $metadataImport);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MetadataImport $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());
}
}
updateService
Updates the parameters of a single service.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. A field mask used to specify the fields to be overwritten in the
metastore service resource by the update.
Fields specified in the |
service |
Google\Cloud\Metastore\V1alpha\Service
Required. The metastore service to update. The server only merges fields
in the service if they are specified in The metastore service's |
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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1alpha\Service;
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_service_sample(): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$service = new Service();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->updateService($updateMask, $service);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Service $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());
}
}
getLocation
Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location | |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\Location;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* 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 get_location_sample(): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $dataprocMetastoreClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ 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. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\Location;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listLocations();
/** @var Location $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());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataprocMetastoreClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataprocMetastoreClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Metastore\V1alpha\DataprocMetastoreClient;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$dataprocMetastoreClient = new DataprocMetastoreClient();
// Prepare any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $dataprocMetastoreClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
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 | |
static::backupName
Formats a string containing the fully-qualified path to represent a backup resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
service |
string
|
backup |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted backup resource. |
static::lakeName
Formats a string containing the fully-qualified path to represent a lake resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
lake |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted lake resource. |
static::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. |
static::metadataImportName
Formats a string containing the fully-qualified path to represent a metadata_import resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
service |
string
|
metadataImport |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted metadata_import resource. |
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
network |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted network resource. |
static::serviceName
Formats a string containing the fully-qualified path to represent a service resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
service |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted service resource. |
static::subnetworkName
Formats a string containing the fully-qualified path to represent a subnetwork resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
region |
string
|
subnetwork |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted subnetwork resource. |
static::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
- backup: projects/{project}/locations/{location}/services/{service}/backups/{backup}
- lake: projects/{project}/locations/{location}/lakes/{lake}
- location: projects/{project}/locations/{location}
- metadataImport: projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}
- network: projects/{project}/global/networks/{network}
- service: projects/{project}/locations/{location}/services/{service}
- subnetwork: projects/{project}/regions/{region}/subnetworks/{subnetwork}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.metastore.v1alpha.DataprocMetastore'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.