Class ControlServiceClient (2.17.0)

Version 2.17.0

• 2.32.0-rc (latest)
• 2.31.0
• 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 Control.

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

ControlServiceClient(ControlServiceClient const &)

Copy and move support

Parameter
Name	Description
	ControlServiceClient const &

ControlServiceClient(ControlServiceClient &&)

Copy and move support

Parameter
Name	Description
	ControlServiceClient &&

ControlServiceClient(std::shared_ptr< ControlServiceConnection >, Options)

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

Operators

operator=(ControlServiceClient const &)

Copy and move support

Parameter
Name	Description
	ControlServiceClient const &

Returns
Type	Description
ControlServiceClient &

operator=(ControlServiceClient &&)

Copy and move support

Parameter
Name	Description
	ControlServiceClient &&

Returns
Type	Description
ControlServiceClient &

Functions

CreateControl(std::string const &, google::cloud::retail::v2::Control const &, std::string const &, Options)

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
parent	std::string const & Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
control	google::cloud::retail::v2::Control const & Required. The Control to create.
control_id	std::string const & Required. The ID to use for the Control, which will become the final component of the Control'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::Control >	the result of the RPC. The response message type (google.cloud.retail.v2.Control) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateControl(google::cloud::retail::v2::CreateControlRequest const &, Options)

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

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

DeleteControl(std::string const &, Options)

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_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.

DeleteControl(google::cloud::retail::v2::DeleteControlRequest const &, Options)

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	google::cloud::retail::v2::DeleteControlRequest 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.DeleteControlRequest. 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.

UpdateControl(google::cloud::retail::v2::Control const &, google::protobuf::FieldMask const &, Options)

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
control	google::cloud::retail::v2::Control const & Required. The Control to update.
update_mask	google::protobuf::FieldMask const & Indicates which fields in the provided Control to update. The following are NOT supported: [Control.name][google.cloud.retail.v2.Control.name] If not set or empty, 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::Control >	the result of the RPC. The response message type (google.cloud.retail.v2.Control) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateControl(google::cloud::retail::v2::UpdateControlRequest const &, Options)

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

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

GetControl(std::string const &, Options)

Gets a Control.

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

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

GetControl(google::cloud::retail::v2::GetControlRequest const &, Options)

Gets a Control.

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

ListControls(std::string const &, Options)

Lists all Controls by their parent [Catalog][google.cloud.retail.v2.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::Control >	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.Control, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListControls(google::cloud::retail::v2::ListControlsRequest, Options)

Lists all Controls by their parent [Catalog][google.cloud.retail.v2.Catalog].

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