Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 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.
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 \ V1 \ ClientMethods
__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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::alterMetadataResourceLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\AlterMetadataResourceLocationRequest
A request to house fields associated with the call. |
callOptions |
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\V1\AlterMetadataResourceLocationRequest;
use Google\Cloud\Metastore\V1\AlterMetadataResourceLocationResponse;
use Google\Cloud\Metastore\V1\Client\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();
// Prepare the request message.
$request = (new AlterMetadataResourceLocationRequest())
->setService($formattedService)
->setResourceName($resourceName)
->setLocationUri($locationUri);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->alterMetadataResourceLocation($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::createBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateBackupRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Backup;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\CreateBackupRequest;
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 the request message.
$backup = new Backup();
$request = (new CreateBackupRequest())
->setParent($formattedParent)
->setBackupId($backupId)
->setBackup($backup);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createBackup($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::createMetadataImportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateMetadataImportRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\CreateMetadataImportRequest;
use Google\Cloud\Metastore\V1\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 the request message.
$metadataImport = new MetadataImport();
$request = (new CreateMetadataImportRequest())
->setParent($formattedParent)
->setMetadataImportId($metadataImportId)
->setMetadataImport($metadataImport);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createMetadataImport($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::createServiceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateServiceRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\CreateServiceRequest;
use Google\Cloud\Metastore\V1\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 the request message.
$service = new Service();
$request = (new CreateServiceRequest())
->setParent($formattedParent)
->setServiceId($serviceId)
->setService($service);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->createService($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::deleteBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\DeleteBackupRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\DeleteBackupRequest;
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();
// Prepare the request message.
$request = (new DeleteBackupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->deleteBackup($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::deleteServiceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\DeleteServiceRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\DeleteServiceRequest;
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();
// Prepare the request message.
$request = (new DeleteServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->deleteService($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::exportMetadataAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ExportMetadataRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\ExportMetadataRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new ExportMetadataRequest())
->setService($formattedService);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->exportMetadata($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::getBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetBackupRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Backup |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1\Backup;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\GetBackupRequest;
/**
* @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();
// Prepare the request message.
$request = (new GetBackupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Backup $response */
$response = $dataprocMetastoreClient->getBackup($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::getMetadataImportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetMetadataImportRequest
A request to house fields associated with the call. |
callOptions |
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\V1\MetadataImport |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\GetMetadataImportRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new GetMetadataImportRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var MetadataImport $response */
$response = $dataprocMetastoreClient->getMetadataImport($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::getServiceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetServiceRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Service |
use Google\ApiCore\ApiException;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\GetServiceRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new GetServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $dataprocMetastoreClient->getService($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::listBackupsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListBackupsRequest
A request to house fields associated with the call. |
callOptions |
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1\Backup;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\ListBackupsRequest;
/**
* @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();
// Prepare the request message.
$request = (new ListBackupsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listBackups($request);
/** @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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::listMetadataImportsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListMetadataImportsRequest
A request to house fields associated with the call. |
callOptions |
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\ListMetadataImportsRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new ListMetadataImportsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listMetadataImports($request);
/** @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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::listServicesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListServicesRequest
A request to house fields associated with the call. |
callOptions |
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\ListServicesRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new ListServicesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listServices($request);
/** @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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::moveTableToDatabaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\MoveTableToDatabaseRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\MoveTableToDatabaseRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new MoveTableToDatabaseRequest())
->setService($formattedService)
->setTableName($tableName)
->setDbName($dbName)
->setDestinationDbName($destinationDbName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->moveTableToDatabase($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::queryMetadataAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\QueryMetadataRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\QueryMetadataRequest;
use Google\Cloud\Metastore\V1\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();
// Prepare the request message.
$request = (new QueryMetadataRequest())
->setService($formattedService)
->setQuery($query);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->queryMetadata($request);
$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);
}
restoreService
Restores a service from a backup.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::restoreServiceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\RestoreServiceRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\Restore;
use Google\Cloud\Metastore\V1\RestoreServiceRequest;
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();
// Prepare the request message.
$request = (new RestoreServiceRequest())
->setService($formattedService)
->setBackup($formattedBackup);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->restoreService($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::updateMetadataImportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\UpdateMetadataImportRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\MetadataImport;
use Google\Cloud\Metastore\V1\UpdateMetadataImportRequest;
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 the request message.
$updateMask = new FieldMask();
$metadataImport = new MetadataImport();
$request = (new UpdateMetadataImportRequest())
->setUpdateMask($updateMask)
->setMetadataImport($metadataImport);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->updateMetadataImport($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::updateServiceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\UpdateServiceRequest
A request to house fields associated with the call. |
callOptions |
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\V1\Client\DataprocMetastoreClient;
use Google\Cloud\Metastore\V1\Service;
use Google\Cloud\Metastore\V1\UpdateServiceRequest;
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 the request message.
$updateMask = new FieldMask();
$service = new Service();
$request = (new UpdateServiceRequest())
->setUpdateMask($updateMask)
->setService($service);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataprocMetastoreClient->updateService($request);
$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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
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\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Metastore\V1\Client\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();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $dataprocMetastoreClient->getLocation($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Metastore\V1\Client\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();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataprocMetastoreClient->listLocations($request);
/** @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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
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\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Metastore\V1\Client\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();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataprocMetastoreClient->getIamPolicy($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
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\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Metastore\V1\Client\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 the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataprocMetastoreClient->setIamPolicy($request);
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.
The async variant is Google\Cloud\Metastore\V1\Client\DataprocMetastoreClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
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\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Metastore\V1\Client\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 the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $dataprocMetastoreClient->testIamPermissions($request);
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);
}
alterMetadataResourceLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\AlterMetadataResourceLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateBackupRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createMetadataImportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateMetadataImportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\CreateServiceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\DeleteBackupRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\DeleteServiceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
exportMetadataAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ExportMetadataRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetBackupRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getMetadataImportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetMetadataImportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\GetServiceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listBackupsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListBackupsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listMetadataImportsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListMetadataImportsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listServicesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\ListServicesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
moveTableToDatabaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\MoveTableToDatabaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
queryMetadataAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\QueryMetadataRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
restoreServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\RestoreServiceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateMetadataImportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\UpdateMetadataImportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Metastore\V1\UpdateServiceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
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::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}
- 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. |