Class SynonymSetServiceClient (2.28.0)

Version 2.28.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

A Service that manage/custom customer specified SynonymSets.

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

SynonymSetServiceClient(SynonymSetServiceClient const &)

Copy and move support

Parameter
Name	Description
	SynonymSetServiceClient const &

SynonymSetServiceClient(SynonymSetServiceClient &&)

Copy and move support

Parameter
Name	Description
	SynonymSetServiceClient &&

SynonymSetServiceClient(std::shared_ptr< SynonymSetServiceConnection >, Options)

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

Operators

operator=(SynonymSetServiceClient const &)

Copy and move support

Parameter
Name	Description
	SynonymSetServiceClient const &

Returns
Type	Description
SynonymSetServiceClient &

operator=(SynonymSetServiceClient &&)

Copy and move support

Parameter
Name	Description
	SynonymSetServiceClient &&

Returns
Type	Description
SynonymSetServiceClient &

Functions

CreateSynonymSet(std::string const &, google::cloud::contentwarehouse::v1::SynonymSet const &, Options)

Creates a SynonymSet for a single context.

Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

Parameters
Name	Description
parent	std::string const & Required. The parent name. Format: projects/{project_number}/locations/{location}.
synonym_set	google::cloud::contentwarehouse::v1::SynonymSet const & Required. The synonymSet to be created for a context
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateSynonymSet(google::cloud::contentwarehouse::v1::CreateSynonymSetRequest const &, Options)

Creates a SynonymSet for a single context.

Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

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

GetSynonymSet(std::string const &, Options)

Gets a SynonymSet for a particular context.

Throws a NOT_FOUND exception if the Synonymset does not exist

Parameters
Name	Description
name	std::string const & Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetSynonymSet(google::cloud::contentwarehouse::v1::GetSynonymSetRequest const &, Options)

Gets a SynonymSet for a particular context.

Throws a NOT_FOUND exception if the Synonymset does not exist

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

UpdateSynonymSet(std::string const &, google::cloud::contentwarehouse::v1::SynonymSet const &, Options)

Remove the existing SynonymSet for the context and replaces it with a new one.

Throws a NOT_FOUND exception if the SynonymSet is not found.

Parameters
Name	Description
name	std::string const & Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
synonym_set	google::cloud::contentwarehouse::v1::SynonymSet const & Required. The synonymSet to be updated for the customer
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateSynonymSet(google::cloud::contentwarehouse::v1::UpdateSynonymSetRequest const &, Options)

Remove the existing SynonymSet for the context and replaces it with a new one.

Throws a NOT_FOUND exception if the SynonymSet is not found.

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

DeleteSynonymSet(std::string const &, Options)

Deletes a SynonymSet for a given context.

Throws a NOT_FOUND exception if the SynonymSet is not found.

Parameters
Name	Description
name	std::string const & Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
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.

DeleteSynonymSet(google::cloud::contentwarehouse::v1::DeleteSynonymSetRequest const &, Options)

Deletes a SynonymSet for a given context.

Throws a NOT_FOUND exception if the SynonymSet is not found.

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

ListSynonymSets(std::string const &, Options)

Returns all SynonymSets (for all contexts) for the specified location.

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

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

ListSynonymSets(google::cloud::contentwarehouse::v1::ListSynonymSetsRequest, Options)

Returns all SynonymSets (for all contexts) for the specified location.

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