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}
.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
DataprocMetastoreClient(DataprocMetastoreClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreClient const &
|
DataprocMetastoreClient(DataprocMetastoreClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreClient &&
|
DataprocMetastoreClient(std::shared_ptr< DataprocMetastoreConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< DataprocMetastoreConnection >
|
opts |
Options
|
Operators
operator=(DataprocMetastoreClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreClient const &
|
Returns | |
---|---|
Type | Description |
DataprocMetastoreClient & |
operator=(DataprocMetastoreClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreClient &&
|
Returns | |
---|---|
Type | Description |
DataprocMetastoreClient & |
Functions
ListServices(std::string const &, Options)
Lists services in a project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the location of metastore services to list, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServices(google::cloud::metastore::v1::ListServicesRequest, Options)
Lists services in a project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::ListServicesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetService(std::string const &, Options)
Gets the details of a single service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the metastore service to retrieve, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::Service > |
the result of the RPC. The response message type (google.cloud.metastore.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetService(google::cloud::metastore::v1::GetServiceRequest const &, Options)
Gets the details of a single service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::GetServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::Service > |
the result of the RPC. The response message type (google.cloud.metastore.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateService(std::string const &, google::cloud::metastore::v1::Service const &, std::string const &, Options)
Creates a metastore service in a project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the location in which to create a metastore service, in the following form: |
service |
google::cloud::metastore::v1::Service const &
Required. The Metastore service to create. The |
service_id |
std::string const &
Required. The ID of the metastore service, which is used as the final component of the metastore service's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
A |
CreateService(NoAwaitTag, std::string const &, google::cloud::metastore::v1::Service const &, std::string const &, Options)
Creates a metastore service in a project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
service |
google::cloud::metastore::v1::Service const &
|
service_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateService(google::cloud::metastore::v1::CreateServiceRequest const &, Options)
Creates a metastore service in a project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::CreateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
A |
CreateService(NoAwaitTag, google::cloud::metastore::v1::CreateServiceRequest const &, Options)
Creates a metastore service in a project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::CreateServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateService(google::longrunning::Operation const &, Options)
Creates a metastore service in a project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
UpdateService(google::cloud::metastore::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single service.
Parameters | |
---|---|
Name | Description |
service |
google::cloud::metastore::v1::Service const &
Required. The metastore service to update. The server only merges fields in the service if they are specified in |
update_mask |
google::protobuf::FieldMask const &
Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::metastore::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single service.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
service |
google::cloud::metastore::v1::Service const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateService(google::cloud::metastore::v1::UpdateServiceRequest const &, Options)
Updates the parameters of a single service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::UpdateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::metastore::v1::UpdateServiceRequest const &, Options)
Updates the parameters of a single service.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::UpdateServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateService(google::longrunning::Operation const &, Options)
Updates the parameters of a single service.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Service > > |
DeleteService(std::string const &, Options)
Deletes a single service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the metastore service to delete, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, std::string const &, Options)
Deletes a single service.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteService(google::cloud::metastore::v1::DeleteServiceRequest const &, Options)
Deletes a single service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::DeleteServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, google::cloud::metastore::v1::DeleteServiceRequest const &, Options)
Deletes a single service.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::DeleteServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteService(google::longrunning::Operation const &, Options)
Deletes a single service.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
ListMetadataImports(std::string const &, Options)
Lists imports in a service.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the service whose metadata imports to list, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::MetadataImport > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListMetadataImports(google::cloud::metastore::v1::ListMetadataImportsRequest, Options)
Lists imports in a service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::ListMetadataImportsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::MetadataImport > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetMetadataImport(std::string const &, Options)
Gets details of a single import.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the metadata import to retrieve, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::MetadataImport > |
the result of the RPC. The response message type (google.cloud.metastore.v1.MetadataImport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetMetadataImport(google::cloud::metastore::v1::GetMetadataImportRequest const &, Options)
Gets details of a single import.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::GetMetadataImportRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::MetadataImport > |
the result of the RPC. The response message type (google.cloud.metastore.v1.MetadataImport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateMetadataImport(std::string const &, google::cloud::metastore::v1::MetadataImport const &, std::string const &, Options)
Creates a new MetadataImport in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the service in which to create a metastore import, in the following form: |
metadata_import |
google::cloud::metastore::v1::MetadataImport const &
Required. The metadata import to create. The |
metadata_import_id |
std::string const &
Required. The ID of the metadata import, which is used as the final component of the metadata import's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
A |
CreateMetadataImport(NoAwaitTag, std::string const &, google::cloud::metastore::v1::MetadataImport const &, std::string const &, Options)
Creates a new MetadataImport in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
metadata_import |
google::cloud::metastore::v1::MetadataImport const &
|
metadata_import_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateMetadataImport(google::cloud::metastore::v1::CreateMetadataImportRequest const &, Options)
Creates a new MetadataImport in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::CreateMetadataImportRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
A |
CreateMetadataImport(NoAwaitTag, google::cloud::metastore::v1::CreateMetadataImportRequest const &, Options)
Creates a new MetadataImport in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::CreateMetadataImportRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateMetadataImport(google::longrunning::Operation const &, Options)
Creates a new MetadataImport in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
UpdateMetadataImport(google::cloud::metastore::v1::MetadataImport const &, google::protobuf::FieldMask const &, Options)
Updates a single import.
Only the description field of MetadataImport is supported to be updated.
Parameters | |
---|---|
Name | Description |
metadata_import |
google::cloud::metastore::v1::MetadataImport const &
Required. The metadata import to update. The server only merges fields in the import if they are specified in |
update_mask |
google::protobuf::FieldMask const &
Required. A field mask used to specify the fields to be overwritten in the metadata import resource by the update. Fields specified in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
A |
UpdateMetadataImport(NoAwaitTag, google::cloud::metastore::v1::MetadataImport const &, google::protobuf::FieldMask const &, Options)
Updates a single import.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
metadata_import |
google::cloud::metastore::v1::MetadataImport const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateMetadataImport(google::cloud::metastore::v1::UpdateMetadataImportRequest const &, Options)
Updates a single import.
Only the description field of MetadataImport is supported to be updated.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::UpdateMetadataImportRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
A |
UpdateMetadataImport(NoAwaitTag, google::cloud::metastore::v1::UpdateMetadataImportRequest const &, Options)
Updates a single import.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::UpdateMetadataImportRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateMetadataImport(google::longrunning::Operation const &, Options)
Updates a single import.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataImport > > |
ExportMetadata(google::cloud::metastore::v1::ExportMetadataRequest const &, Options)
Exports metadata from a service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::ExportMetadataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataExport > > |
A |
ExportMetadata(NoAwaitTag, google::cloud::metastore::v1::ExportMetadataRequest const &, Options)
Exports metadata from a service.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::ExportMetadataRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ExportMetadata(google::longrunning::Operation const &, Options)
Exports metadata from a service.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MetadataExport > > |
RestoreService(std::string const &, std::string const &, Options)
Restores a service from a backup.
Parameters | |
---|---|
Name | Description |
service |
std::string const &
Required. The relative resource name of the metastore service to run restore, in the following form: |
backup |
std::string const &
Required. The relative resource name of the metastore service backup to restore from, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Restore > > |
A |
RestoreService(NoAwaitTag, std::string const &, std::string const &, Options)
Restores a service from a backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
service |
std::string const &
|
backup |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreService(google::cloud::metastore::v1::RestoreServiceRequest const &, Options)
Restores a service from a backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::RestoreServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Restore > > |
A |
RestoreService(NoAwaitTag, google::cloud::metastore::v1::RestoreServiceRequest const &, Options)
Restores a service from a backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::RestoreServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreService(google::longrunning::Operation const &, Options)
Restores a service from a backup.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Restore > > |
ListBackups(std::string const &, Options)
Lists backups in a service.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the service whose backups to list, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::Backup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackups(google::cloud::metastore::v1::ListBackupsRequest, Options)
Lists backups in a service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::ListBackupsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::Backup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBackup(std::string const &, Options)
Gets details of a single backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the backup to retrieve, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::Backup > |
the result of the RPC. The response message type (google.cloud.metastore.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackup(google::cloud::metastore::v1::GetBackupRequest const &, Options)
Gets details of a single backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::GetBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::Backup > |
the result of the RPC. The response message type (google.cloud.metastore.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateBackup(std::string const &, google::cloud::metastore::v1::Backup const &, std::string const &, Options)
Creates a new backup in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the service in which to create a backup of the following form: |
backup |
google::cloud::metastore::v1::Backup const &
Required. The backup to create. The |
backup_id |
std::string const &
Required. The ID of the backup, which is used as the final component of the backup's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Backup > > |
A |
CreateBackup(NoAwaitTag, std::string const &, google::cloud::metastore::v1::Backup const &, std::string const &, Options)
Creates a new backup in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
backup |
google::cloud::metastore::v1::Backup const &
|
backup_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackup(google::cloud::metastore::v1::CreateBackupRequest const &, Options)
Creates a new backup in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::CreateBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Backup > > |
A |
CreateBackup(NoAwaitTag, google::cloud::metastore::v1::CreateBackupRequest const &, Options)
Creates a new backup in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::CreateBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackup(google::longrunning::Operation const &, Options)
Creates a new backup in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Backup > > |
DeleteBackup(std::string const &, Options)
Deletes a single backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the backup to delete, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
A |
DeleteBackup(NoAwaitTag, std::string const &, Options)
Deletes a single backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackup(google::cloud::metastore::v1::DeleteBackupRequest const &, Options)
Deletes a single backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::DeleteBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
A |
DeleteBackup(NoAwaitTag, google::cloud::metastore::v1::DeleteBackupRequest const &, Options)
Deletes a single backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::DeleteBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackup(google::longrunning::Operation const &, Options)
Deletes a single backup.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > |
QueryMetadata(google::cloud::metastore::v1::QueryMetadataRequest const &, Options)
Query DPMS metadata.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::QueryMetadataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::QueryMetadataResponse > > |
A |
QueryMetadata(NoAwaitTag, google::cloud::metastore::v1::QueryMetadataRequest const &, Options)
Query DPMS metadata.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::QueryMetadataRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
QueryMetadata(google::longrunning::Operation const &, Options)
Query DPMS metadata.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::QueryMetadataResponse > > |
MoveTableToDatabase(google::cloud::metastore::v1::MoveTableToDatabaseRequest const &, Options)
Move a table to another database.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::MoveTableToDatabaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MoveTableToDatabaseResponse > > |
A |
MoveTableToDatabase(NoAwaitTag, google::cloud::metastore::v1::MoveTableToDatabaseRequest const &, Options)
Move a table to another database.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::MoveTableToDatabaseRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
MoveTableToDatabase(google::longrunning::Operation const &, Options)
Move a table to another database.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::MoveTableToDatabaseResponse > > |
AlterMetadataResourceLocation(google::cloud::metastore::v1::AlterMetadataResourceLocationRequest const &, Options)
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 |
request |
google::cloud::metastore::v1::AlterMetadataResourceLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::AlterMetadataResourceLocationResponse > > |
A |
AlterMetadataResourceLocation(NoAwaitTag, google::cloud::metastore::v1::AlterMetadataResourceLocationRequest const &, Options)
Alter metadata resource location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::metastore::v1::AlterMetadataResourceLocationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
AlterMetadataResourceLocation(google::longrunning::Operation const &, Options)
Alter metadata resource location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::AlterMetadataResourceLocationResponse > > |