Class ProductServiceClient (2.28.0)

Service for ingesting Product information of the customer's website.

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

ProductServiceClient(ProductServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ProductServiceClient const &`

ProductServiceClient(ProductServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ProductServiceClient &&`

ProductServiceClient(std::shared_ptr< ProductServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ProductServiceConnection >`
`opts`	`Options`

Operators

operator=(ProductServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ProductServiceClient const &`

Returns
Type	Description
`ProductServiceClient &`

operator=(ProductServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ProductServiceClient &&`

Returns
Type	Description
`ProductServiceClient &`

Functions

CreateProduct(std::string const &, google::cloud::retail::v2::Product const &, std::string const &, Options)

Creates a Product.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
`product`	`google::cloud::retail::v2::Product const &` Required. The Product to create.
`product_id`	`std::string const &` Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::retail::v2::Product >`	the result of the RPC. The response message type (google.cloud.retail.v2.Product) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateProduct(google::cloud::retail::v2::CreateProductRequest const &, Options)

Creates a Product.

Parameters
Name	Description
`request`	`google::cloud::retail::v2::CreateProductRequest const &` Unary 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.retail.v2.CreateProductRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::retail::v2::Product >`	the result of the RPC. The response message type (google.cloud.retail.v2.Product) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetProduct(std::string const &, Options)

Gets a Product.

Parameters
Name	Description
`name`	`std::string const &` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catal`