Google Cloud BigQuery C++ Client 2.13.0
A C++ Client Library for Google Cloud BigQuery
Loading...
Searching...
No Matches
Public Member Functions | List of all members
google::cloud::bigquery_biglake_v1::MetastoreServiceClient Class Reference

BigLake Metastore is a serverless, highly available, multi-tenant runtime metastore for Google Cloud Data Analytics products. More...

#include <google/cloud/bigquery/biglake/v1/metastore_client.h>

Public Member Functions

 MetastoreServiceClient (std::shared_ptr< MetastoreServiceConnection > connection, Options opts={})
 
 ~MetastoreServiceClient ()
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > CreateCatalog (std::string const &parent, google::cloud::bigquery::biglake::v1::Catalog const &catalog, std::string const &catalog_id, Options opts={})
 Creates a new catalog. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > CreateCatalog (google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &request, Options opts={})
 Creates a new catalog. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > DeleteCatalog (std::string const &name, Options opts={})
 Deletes an existing catalog specified by the catalog ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > DeleteCatalog (google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &request, Options opts={})
 Deletes an existing catalog specified by the catalog ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > GetCatalog (std::string const &name, Options opts={})
 Gets the catalog specified by the resource name. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > GetCatalog (google::cloud::bigquery::biglake::v1::GetCatalogRequest const &request, Options opts={})
 Gets the catalog specified by the resource name. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Catalog > ListCatalogs (std::string const &parent, Options opts={})
 List all catalogs in a specified project. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Catalog > ListCatalogs (google::cloud::bigquery::biglake::v1::ListCatalogsRequest request, Options opts={})
 List all catalogs in a specified project. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > CreateDatabase (std::string const &parent, google::cloud::bigquery::biglake::v1::Database const &database, std::string const &database_id, Options opts={})
 Creates a new database. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > CreateDatabase (google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &request, Options opts={})
 Creates a new database. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > DeleteDatabase (std::string const &name, Options opts={})
 Deletes an existing database specified by the database ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > DeleteDatabase (google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &request, Options opts={})
 Deletes an existing database specified by the database ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > UpdateDatabase (google::cloud::bigquery::biglake::v1::Database const &database, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates an existing database specified by the database ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > UpdateDatabase (google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &request, Options opts={})
 Updates an existing database specified by the database ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > GetDatabase (std::string const &name, Options opts={})
 Gets the database specified by the resource name. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Database > GetDatabase (google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &request, Options opts={})
 Gets the database specified by the resource name. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Database > ListDatabases (std::string const &parent, Options opts={})
 List all databases in a specified catalog. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Database > ListDatabases (google::cloud::bigquery::biglake::v1::ListDatabasesRequest request, Options opts={})
 List all databases in a specified catalog. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > CreateTable (std::string const &parent, google::cloud::bigquery::biglake::v1::Table const &table, std::string const &table_id, Options opts={})
 Creates a new table. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > CreateTable (google::cloud::bigquery::biglake::v1::CreateTableRequest const &request, Options opts={})
 Creates a new table. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > DeleteTable (std::string const &name, Options opts={})
 Deletes an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > DeleteTable (google::cloud::bigquery::biglake::v1::DeleteTableRequest const &request, Options opts={})
 Deletes an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > UpdateTable (google::cloud::bigquery::biglake::v1::Table const &table, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > UpdateTable (google::cloud::bigquery::biglake::v1::UpdateTableRequest const &request, Options opts={})
 Updates an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > RenameTable (std::string const &name, std::string const &new_name, Options opts={})
 Renames an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > RenameTable (google::cloud::bigquery::biglake::v1::RenameTableRequest const &request, Options opts={})
 Renames an existing table specified by the table ID. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > GetTable (std::string const &name, Options opts={})
 Gets the table specified by the resource name. More...
 
StatusOr< google::cloud::bigquery::biglake::v1::Table > GetTable (google::cloud::bigquery::biglake::v1::GetTableRequest const &request, Options opts={})
 Gets the table specified by the resource name. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Table > ListTables (std::string const &parent, Options opts={})
 List all tables in a specified database. More...
 
StreamRange< google::cloud::bigquery::biglake::v1::Table > ListTables (google::cloud::bigquery::biglake::v1::ListTablesRequest request, Options opts={})
 List all tables in a specified database. More...
 
Copy and move support
 MetastoreServiceClient (MetastoreServiceClient const &)=default
 
MetastoreServiceClientoperator= (MetastoreServiceClient const &)=default
 
 MetastoreServiceClient (MetastoreServiceClient &&)=default
 
MetastoreServiceClientoperator= (MetastoreServiceClient &&)=default
 

Friends

Equality
bool operator== (MetastoreServiceClient const &a, MetastoreServiceClient const &b)
 
bool operator!= (MetastoreServiceClient const &a, MetastoreServiceClient const &b)
 

Detailed Description

BigLake Metastore is a serverless, highly available, multi-tenant runtime metastore for Google Cloud Data Analytics products.

The BigLake Metastore API defines the following resource model:

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.

Constructor & Destructor Documentation

◆ MetastoreServiceClient() [1/3]

google::cloud::bigquery_biglake_v1::MetastoreServiceClient::MetastoreServiceClient ( std::shared_ptr< MetastoreServiceConnection connection,
Options  opts = {} 
)
explicit

◆ ~MetastoreServiceClient()

google::cloud::bigquery_biglake_v1::MetastoreServiceClient::~MetastoreServiceClient ( )

◆ MetastoreServiceClient() [2/3]

google::cloud::bigquery_biglake_v1::MetastoreServiceClient::MetastoreServiceClient ( MetastoreServiceClient const &  )
default

◆ MetastoreServiceClient() [3/3]

google::cloud::bigquery_biglake_v1::MetastoreServiceClient::MetastoreServiceClient ( MetastoreServiceClient &&  )
default

Member Function Documentation

◆ CreateCatalog() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateCatalog ( google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &  request,
Options  opts = {} 
)

Creates a new catalog.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ CreateCatalog() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateCatalog ( std::string const &  parent,
google::cloud::bigquery::biglake::v1::Catalog const &  catalog,
std::string const &  catalog_id,
Options  opts = {} 
)

Creates a new catalog.

Parameters
parentRequired. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}
catalogRequired. The catalog to create. The name field does not need to be provided.
catalog_idRequired. The ID to use for the catalog, which will become the final component of the catalog's resource name.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ CreateDatabase() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateDatabase ( google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &  request,
Options  opts = {} 
)

Creates a new database.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ CreateDatabase() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateDatabase ( std::string const &  parent,
google::cloud::bigquery::biglake::v1::Database const &  database,
std::string const &  database_id,
Options  opts = {} 
)

Creates a new database.

Parameters
parentRequired. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
databaseRequired. The database to create. The name field does not need to be provided.
database_idRequired. The ID to use for the database, which will become the final component of the database's resource name.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ CreateTable() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateTable ( google::cloud::bigquery::biglake::v1::CreateTableRequest const &  request,
Options  opts = {} 
)

Creates a new table.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ CreateTable() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::CreateTable ( std::string const &  parent,
google::cloud::bigquery::biglake::v1::Table const &  table,
std::string const &  table_id,
Options  opts = {} 
)

Creates a new table.

Parameters
parentRequired. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
tableRequired. The table to create. The name field does not need to be provided for the table creation.
table_idRequired. The ID to use for the table, which will become the final component of the table's resource name.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteCatalog() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteCatalog ( google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &  request,
Options  opts = {} 
)

Deletes an existing catalog specified by the catalog ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteCatalog() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteCatalog ( std::string const &  name,
Options  opts = {} 
)

Deletes an existing catalog specified by the catalog ID.

Parameters
nameRequired. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteDatabase() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteDatabase ( google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &  request,
Options  opts = {} 
)

Deletes an existing database specified by the database ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteDatabase() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteDatabase ( std::string const &  name,
Options  opts = {} 
)

Deletes an existing database specified by the database ID.

Parameters
nameRequired. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteTable() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteTable ( google::cloud::bigquery::biglake::v1::DeleteTableRequest const &  request,
Options  opts = {} 
)

Deletes an existing table specified by the table ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ DeleteTable() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::DeleteTable ( std::string const &  name,
Options  opts = {} 
)

Deletes an existing table specified by the table ID.

Parameters
nameRequired. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetCatalog() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetCatalog ( google::cloud::bigquery::biglake::v1::GetCatalogRequest const &  request,
Options  opts = {} 
)

Gets the catalog specified by the resource name.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetCatalog() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetCatalog ( std::string const &  name,
Options  opts = {} 
)

Gets the catalog specified by the resource name.

Parameters
nameRequired. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetDatabase() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetDatabase ( google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &  request,
Options  opts = {} 
)

Gets the database specified by the resource name.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetDatabase() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetDatabase ( std::string const &  name,
Options  opts = {} 
)

Gets the database specified by the resource name.

Parameters
nameRequired. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetTable() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetTable ( google::cloud::bigquery::biglake::v1::GetTableRequest const &  request,
Options  opts = {} 
)

Gets the table specified by the resource name.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ GetTable() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::GetTable ( std::string const &  name,
Options  opts = {} 
)

Gets the table specified by the resource name.

Parameters
nameRequired. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ ListCatalogs() [1/2]

StreamRange< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListCatalogs ( google::cloud::bigquery::biglake::v1::ListCatalogsRequest  request,
Options  opts = {} 
)

List all catalogs in a specified project.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListCatalogsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ ListCatalogs() [2/2]

StreamRange< google::cloud::bigquery::biglake::v1::Catalog > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListCatalogs ( std::string const &  parent,
Options  opts = {} 
)

List all catalogs in a specified project.

Parameters
parentRequired. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ ListDatabases() [1/2]

StreamRange< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListDatabases ( google::cloud::bigquery::biglake::v1::ListDatabasesRequest  request,
Options  opts = {} 
)

List all databases in a specified catalog.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListDatabasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ ListDatabases() [2/2]

StreamRange< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListDatabases ( std::string const &  parent,
Options  opts = {} 
)

List all databases in a specified catalog.

Parameters
parentRequired. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ ListTables() [1/2]

StreamRange< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListTables ( google::cloud::bigquery::biglake::v1::ListTablesRequest  request,
Options  opts = {} 
)

List all tables in a specified database.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListTablesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ ListTables() [2/2]

StreamRange< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::ListTables ( std::string const &  parent,
Options  opts = {} 
)

List all tables in a specified database.

Parameters
parentRequired. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

◆ operator=() [1/2]

MetastoreServiceClient & google::cloud::bigquery_biglake_v1::MetastoreServiceClient::operator= ( MetastoreServiceClient &&  )
default

◆ operator=() [2/2]

MetastoreServiceClient & google::cloud::bigquery_biglake_v1::MetastoreServiceClient::operator= ( MetastoreServiceClient const &  )
default

◆ RenameTable() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::RenameTable ( google::cloud::bigquery::biglake::v1::RenameTableRequest const &  request,
Options  opts = {} 
)

Renames an existing table specified by the table ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.RenameTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ RenameTable() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::RenameTable ( std::string const &  name,
std::string const &  new_name,
Options  opts = {} 
)

Renames an existing table specified by the table ID.

Parameters
nameRequired. The table's name field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
new_nameRequired. The new name for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ UpdateDatabase() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::UpdateDatabase ( google::cloud::bigquery::biglake::v1::Database const &  database,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates an existing database specified by the database ID.

Parameters
databaseRequired. The database to update.
The database's name field is used to identify the database to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
update_maskThe list of fields to update.
For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ UpdateDatabase() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Database > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::UpdateDatabase ( google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &  request,
Options  opts = {} 
)

Updates an existing database specified by the database ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.UpdateDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ UpdateTable() [1/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::UpdateTable ( google::cloud::bigquery::biglake::v1::Table const &  table,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates an existing table specified by the table ID.

Parameters
tableRequired. The table to update.
The table's name field is used to identify the table to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
update_maskThe list of fields to update.
For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

◆ UpdateTable() [2/2]

StatusOr< google::cloud::bigquery::biglake::v1::Table > google::cloud::bigquery_biglake_v1::MetastoreServiceClient::UpdateTable ( google::cloud::bigquery::biglake::v1::UpdateTableRequest const &  request,
Options  opts = {} 
)

Updates an existing table specified by the table ID.

Parameters
requestUnary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.UpdateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( MetastoreServiceClient const &  a,
MetastoreServiceClient const &  b 
)
friend

◆ operator==

bool operator== ( MetastoreServiceClient const &  a,
MetastoreServiceClient const &  b 
)
friend