java.lang.Object
- com.google.cloud.support.v2.CommentServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
public class CommentServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: A service to manage comments on cases.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CommentServiceClient commentServiceClient = CommentServiceClient.create()) {
   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   Comment comment = Comment.newBuilder().build();
   Comment response = commentServiceClient.createComment(parent, comment);
 }

Note: close() needs to be called on the CommentServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CommentServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CommentServiceSettings commentServiceSettings =
     CommentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CommentServiceClient commentServiceClient = CommentServiceClient.create(commentServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CommentServiceSettings commentServiceSettings =
     CommentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CommentServiceClient commentServiceClient = CommentServiceClient.create(commentServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CommentServiceSettings commentServiceSettings =
     CommentServiceSettings.newHttpJsonBuilder().build();
 CommentServiceClient commentServiceClient = CommentServiceClient.create(commentServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CommentServiceClient.ListCommentsFixedSizeCollection`
`static class`	`CommentServiceClient.ListCommentsPage`
`static class`	`CommentServiceClient.ListCommentsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`CommentServiceClient(CommentServiceSettings settings)`	Constructs an instance of CommentServiceClient, using the given settings.
`protected`	`CommentServiceClient(CommentServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static CommentServiceClient`	`create()`	Constructs an instance of CommentServiceClient with default settings.
`static CommentServiceClient`	`create(CommentServiceSettings settings)`	Constructs an instance of CommentServiceClient, using the given settings.
`static CommentServiceClient`	`create(CommentServiceStub stub)`	Constructs an instance of CommentServiceClient, using the given stub for making calls.
`Comment`	`createComment(CaseName parent, Comment comment)`	Add a new comment to the specified Case.
`Comment`	`createComment(CreateCommentRequest request)`	Add a new comment to the specified Case.
`Comment`	`createComment(String parent, Comment comment)`	Add a new comment to the specified Case.
`com.google.api.gax.rpc.UnaryCallable<CreateCommentRequest,Comment>`	`createCommentCallable()`	Add a new comment to the specified Case.
`CommentServiceSettings`	`getSettings()`
`CommentServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`CommentServiceClient.ListCommentsPagedResponse`	`listComments(CaseName parent)`	Retrieve all Comments associated with the Case object.
`CommentServiceClient.ListCommentsPagedResponse`	`listComments(ListCommentsRequest request)`	Retrieve all Comments associated with the Case object.
`CommentServiceClient.ListCommentsPagedResponse`	`listComments(String parent)`	Retrieve all Comments associated with the Case object.
`com.google.api.gax.rpc.UnaryCallable<ListCommentsRequest,ListCommentsResponse>`	`listCommentsCallable()`	Retrieve all Comments associated with the Case object.
`com.google.api.gax.rpc.UnaryCallable<ListCommentsRequest,CommentServiceClient.ListCommentsPagedResponse>`	`listCommentsPagedCallable()`	Retrieve all Comments associated with the Case object.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CommentServiceClient
```
protected CommentServiceClient(CommentServiceSettings settings)
                        throws IOException
```
  Constructs an instance of CommentServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- CommentServiceClient
```
protected CommentServiceClient(CommentServiceStub stub)
```

Method Detail

create

public static final CommentServiceClient create()
                                         throws IOException

Constructs an instance of CommentServiceClient with default settings.

Throws:: IOException

create
```
public static final CommentServiceClient create(CommentServiceSettings settings)
                                         throws IOException
```
Constructs an instance of CommentServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final CommentServiceClient create(CommentServiceStub stub)
```
Constructs an instance of CommentServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CommentServiceSettings).

getSettings

public final CommentServiceSettings getSettings()

getStub
```
public CommentServiceStub getStub()
```