Class RuleSetServiceClient (2.22.0-rc)

Service to manage customer specific RuleSets.

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

RuleSetServiceClient(RuleSetServiceClient const &)

Copy and move support

Parameter
NameDescription
RuleSetServiceClient const &

RuleSetServiceClient(RuleSetServiceClient &&)

Copy and move support

Parameter
NameDescription
RuleSetServiceClient &&

RuleSetServiceClient(std::shared_ptr< RuleSetServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< RuleSetServiceConnection >
opts Options

Operators

operator=(RuleSetServiceClient const &)

Copy and move support

Parameter
NameDescription
RuleSetServiceClient const &
Returns
TypeDescription
RuleSetServiceClient &

operator=(RuleSetServiceClient &&)

Copy and move support

Parameter
NameDescription
RuleSetServiceClient &&
Returns
TypeDescription
RuleSetServiceClient &

Functions

CreateRuleSet(std::string const &, google::cloud::contentwarehouse::v1::RuleSet const &, Options)

Creates a ruleset.

Parameters
NameDescription
parent std::string const &

Required. The parent name. Format: projects/{project_number}/locations/{location}.

rule_set google::cloud::contentwarehouse::v1::RuleSet const &

Required. The rule set to create.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateRuleSet(google::cloud::contentwarehouse::v1::CreateRuleSetRequest const &, Options)

Creates a ruleset.

Parameters
NameDescription
request google::cloud::contentwarehouse::v1::CreateRuleSetRequest 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.contentwarehouse.v1.CreateRuleSetRequest. 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
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRuleSet(std::string const &, Options)

Gets a ruleset.

Returns NOT_FOUND if the ruleset does not exist.

Parameters
NameDescription
name std::string const &

Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRuleSet(google::cloud::contentwarehouse::v1::GetRuleSetRequest const &, Options)

Gets a ruleset.

Returns NOT_FOUND if the ruleset does not exist.

Parameters
NameDescription
request google::cloud::contentwarehouse::v1::GetRuleSetRequest 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.contentwarehouse.v1.GetRuleSetRequest. 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
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRuleSet(std::string const &, google::cloud::contentwarehouse::v1::RuleSet const &, Options)

Updates a ruleset.

Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

Parameters
NameDescription
name std::string const &

Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

rule_set google::cloud::contentwarehouse::v1::RuleSet const &

Required. The rule set to update.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRuleSet(google::cloud::contentwarehouse::v1::UpdateRuleSetRequest const &, Options)

Updates a ruleset.

Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

Parameters
NameDescription
request google::cloud::contentwarehouse::v1::UpdateRuleSetRequest 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.contentwarehouse.v1.UpdateRuleSetRequest. 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
TypeDescription
StatusOr< google::cloud::contentwarehouse::v1::RuleSet >

the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.RuleSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteRuleSet(std::string const &, Options)

Deletes a ruleset.

Returns NOT_FOUND if the document does not exist.

Parameters
NameDescription
name std::string const &

Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

opts Options

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

Returns
TypeDescription
Status

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

DeleteRuleSet(google::cloud::contentwarehouse::v1::DeleteRuleSetRequest const &, Options)

Deletes a ruleset.

Returns NOT_FOUND if the document does not exist.

Parameters
NameDescription
request google::cloud::contentwarehouse::v1::DeleteRuleSetRequest 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.contentwarehouse.v1.DeleteRuleSetRequest. 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
TypeDescription
Status

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

ListRuleSets(std::string const &, Options)

Lists rulesets.

Parameters
NameDescription
parent std::string const &

Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.

opts Options

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

Returns
TypeDescription
StreamRange< google::cloud::contentwarehouse::v1::RuleSet >

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

ListRuleSets(google::cloud::contentwarehouse::v1::ListRuleSetsRequest, Options)

Lists rulesets.

Parameters
NameDescription
request google::cloud::contentwarehouse::v1::ListRuleSetsRequest

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.contentwarehouse.v1.ListRuleSetsRequest. 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
TypeDescription
StreamRange< google::cloud::contentwarehouse::v1::RuleSet >

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