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: |
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. |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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:
|
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |