Class ControlServiceClient (2.32.0)

Service for performing CRUD operations on Controls.

Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

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::discoveryengine::v1::Control const &, std::string const &, Options)

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. 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 data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control google::cloud::discoveryengine::v1::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 must be within 1-63 characters. 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::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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::discoveryengine::v1::CreateControlRequest const &, Options)

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name Description
request google::cloud::discoveryengine::v1::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.discoveryengine.v1.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::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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::discoveryengine::v1::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::discoveryengine::v1::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.discoveryengine.v1.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::discoveryengine::v1::Control const &, google::protobuf::FieldMask const &, Options)

Updates a Control.

Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
control google::cloud::discoveryengine::v1::Control const &

Required. The Control to update.

update_mask google::protobuf::FieldMask const &

Optional. 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::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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::discoveryengine::v1::UpdateControlRequest const &, Options)

Updates a Control.

Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request google::cloud::discoveryengine::v1::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.discoveryengine.v1.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::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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::discoveryengine::v1::GetControlRequest const &, Options)

Gets a Control.

Parameters
Name Description
request google::cloud::discoveryengine::v1::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.discoveryengine.v1.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::discoveryengine::v1::Control >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.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 [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name Description
parent std::string const &

Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::discoveryengine::v1::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.discoveryengine.v1.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::discoveryengine::v1::ListControlsRequest, Options)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

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.

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 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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. 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::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 StatusOr contains the error details.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

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.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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.