Class CommentServiceClient (2.22.0)

A service to manage comments on cases.

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

CommentServiceClient(CommentServiceClient const &)

Copy and move support

Parameter
NameDescription
CommentServiceClient const &

CommentServiceClient(CommentServiceClient &&)

Copy and move support

Parameter
NameDescription
CommentServiceClient &&

CommentServiceClient(std::shared_ptr< CommentServiceConnection >, Options)

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

Operators

operator=(CommentServiceClient const &)

Copy and move support

Parameter
NameDescription
CommentServiceClient const &
Returns
TypeDescription
CommentServiceClient &

operator=(CommentServiceClient &&)

Copy and move support

Parameter
NameDescription
CommentServiceClient &&
Returns
TypeDescription
CommentServiceClient &

Functions

ListComments(std::string const &, Options)

Retrieve all Comments associated with the Case object.

Parameters
NameDescription
parent std::string const &

Required. The resource name of Case object for which comments should be listed.

opts Options

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

Returns
TypeDescription
StreamRange< google::cloud::support::v2::Comment >

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

ListComments(google::cloud::support::v2::ListCommentsRequest, Options)

Retrieve all Comments associated with the Case object.

Parameters
NameDescription
request google::cloud::support::v2::ListCommentsRequest

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.support.v2.ListCommentsRequest. 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::support::v2::Comment >

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

CreateComment(std::string const &, google::cloud::support::v2::Comment const &, Options)

Add a new comment to the specified Case.

The comment object must have the following fields set: body.

Parameters
NameDescription
parent std::string const &

Required. The resource name of Case to which this comment should be added.

comment google::cloud::support::v2::Comment const &

Required. The Comment object to be added to this Case.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::support::v2::Comment >

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

CreateComment(google::cloud::support::v2::CreateCommentRequest const &, Options)

Add a new comment to the specified Case.

The comment object must have the following fields set: body.

Parameters
NameDescription
request google::cloud::support::v2::CreateCommentRequest 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.support.v2.CreateCommentRequest. 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::support::v2::Comment >

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