Class CatalogServiceClient (2.26.0-rc)

Service for managing catalog configuration.

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

CatalogServiceClient(CatalogServiceClient const &)

Copy and move support

Parameter
Name Description
CatalogServiceClient const &

CatalogServiceClient(CatalogServiceClient &&)

Copy and move support

Parameter
Name Description
CatalogServiceClient &&

CatalogServiceClient(std::shared_ptr< CatalogServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< CatalogServiceConnection >
opts Options

Operators

operator=(CatalogServiceClient const &)

Copy and move support

Parameter
Name Description
CatalogServiceClient const &
Returns
Type Description
CatalogServiceClient &

operator=(CatalogServiceClient &&)

Copy and move support

Parameter
Name Description
CatalogServiceClient &&
Returns
Type Description
CatalogServiceClient &

Functions

ListCatalogs(std::string const &, Options)

Lists all the Catalogs associated with the project.

Parameters
Name Description
parent std::string const &

Required. The account resource name with an associated location.
If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::retail::v2::Catalog >

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 a