Class ServingConfigServiceClient (2.22.0)

Version 2.22.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for modifying ServingConfig.

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

ServingConfigServiceClient(ServingConfigServiceClient const &)

Copy and move support

Parameter
Name	Description
	ServingConfigServiceClient const &

ServingConfigServiceClient(ServingConfigServiceClient &&)

Copy and move support

Parameter
Name	Description
	ServingConfigServiceClient &&

ServingConfigServiceClient(std::shared_ptr< ServingConfigServiceConnection >, Options)

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

Operators

operator=(ServingConfigServiceClient const &)

Copy and move support

Parameter
Name	Description
	ServingConfigServiceClient const &

Returns
Type	Description
ServingConfigServiceClient &

operator=(ServingConfigServiceClient &&)

Copy and move support

Parameter
Name	Description
	ServingConfigServiceClient &&

Returns
Type	Description
ServingConfigServiceClient &

Functions

CreateServingConfig(std::string const &, google::cloud::retail::v2::ServingConfig const &, std::string const &, Options)

Creates a ServingConfig.

A maximum of 100 ServingConfigs are allowed in a [Catalog][google.cloud.retail.v2.Catalog], otherwise a FAILED_PRECONDITION error is returned.

Parameters
Name	Description
parent	std::string const & Required. Full resource name of parent. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
serving_config	google::cloud::retail::v2::ServingConfig const & Required. The ServingConfig to create.
serving_config_id	std::string const & Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateServingConfig(google::cloud::retail::v2::CreateServingConfigRequest const &, Options)

Creates a ServingConfig.

A maximum of 100 ServingConfigs are allowed in a [Catalog][google.cloud.retail.v2.Catalog], otherwise a FAILED_PRECONDITION error is returned.

Parameters
Name	Description
request	google::cloud::retail::v2::CreateServingConfigRequest 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.CreateServingConfigRequest. 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::ServingConfig >	the result of the RPC. The response message type (google.cloud.retail.v2.ServingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteServingConfig(std::string const &, Options)

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
name	std::string const & Required. The resource name of the ServingConfig to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteServingConfig(google::cloud::retail::v2::DeleteServingConfigRequest const &, Options)

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
request	google::cloud::retail::v2::DeleteServingConfigRequest 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.DeleteServingConfigRequest. 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
Status	a Status object. If the request failed, the status contains the details of the failure.

UpdateServingConfig(google::cloud::retail::v2::ServingConfig const &, google::protobuf::FieldMask const &, Options)

Updates a ServingConfig.

Parameters
Name	Description
serving_config	google::cloud::retail::v2::ServingConfig const & Required. The ServingConfig to update.
update_mask	google::protobuf::FieldMask const & Indicates which fields in the provided ServingConfig to update. The following are NOT supported: ServingConfig.name If not set, all supported fields are updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateServingConfig(google::cloud::retail::v2::UpdateServingConfigRequest const &, Options)

Updates a ServingConfig.

Parameters
Name	Description
request	google::cloud::retail::v2::UpdateServingConfigRequest 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.UpdateServingConfigRequest. 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::ServingConfig >	the result of the RPC. The response message type (google.cloud.retail.v2.ServingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetServingConfig(std::string const &, Options)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
name	std::string const & Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetServingConfig(google::cloud::retail::v2::GetServingConfigRequest const &, Options)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
request	google::cloud::retail::v2::GetServingConfigRequest 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.GetServingConfigRequest. 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::ServingConfig >	the result of the RPC. The response message type (google.cloud.retail.v2.ServingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListServingConfigs(std::string const &, Options)

Lists all ServingConfigs linked to this catalog.

Parameters
Name	Description
parent	std::string const & Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::retail::v2::ServingConfig >	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.retail.v2.ServingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListServingConfigs(google::cloud::retail::v2::ListServingConfigsRequest, Options)

Lists all ServingConfigs linked to this catalog.

Parameters
Name	Description
request	google::cloud::retail::v2::ListServingConfigsRequest 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.ListServingConfigsRequest. 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
StreamRange< google::cloud::retail::v2::ServingConfig >	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.retail.v2.ServingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AddControl(std::string const &, Options)

Enables a Control on the specified ServingConfig.

The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Parameters
Name	Description
serving_config	std::string const & Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

AddControl(google::cloud::retail::v2::AddControlRequest const &, Options)

Enables a Control on the specified ServingConfig.

The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Parameters
Name	Description
request	google::cloud::retail::v2::AddControlRequest 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.AddControlRequest. 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::ServingConfig >	the result of the RPC. The response message type (google.cloud.retail.v2.ServingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RemoveControl(std::string const &, Options)

Disables a Control on the specified ServingConfig.

The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters
Name	Description
serving_config	std::string const & Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

RemoveControl(google::cloud::retail::v2::RemoveControlRequest const &, Options)

Disables a Control on the specified ServingConfig.

The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters
Name	Description
request	google::cloud::retail::v2::RemoveControlRequest 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.RemoveControlRequest. 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::ServingConfig >	the result of the RPC. The response message type (google.cloud.retail.v2.ServingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.