- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
| GitHub Repository | Product Reference |
Service Description: A service to view case feed items.
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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
for (FeedItem element : feedServiceClient.showFeed(parent).iterateAll()) {
// doThingsWith(element);
}
}
Note: close() needs to be called on the FeedServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ShowFeed |
Show items in the feed of this case, including case emails, attachments, and comments. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 FeedServiceSettings 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
FeedServiceSettings feedServiceSettings =
FeedServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
FeedServiceClient feedServiceClient = FeedServiceClient.create(feedServiceSettings);
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
FeedServiceSettings feedServiceSettings =
FeedServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
FeedServiceClient feedServiceClient = FeedServiceClient.create(feedServiceSettings);
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
FeedServiceSettings feedServiceSettings = FeedServiceSettings.newHttpJsonBuilder().build();
FeedServiceClient feedServiceClient = FeedServiceClient.create(feedServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final FeedServiceClient create()Constructs an instance of FeedServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(FeedServiceSettings settings)
public static final FeedServiceClient create(FeedServiceSettings settings)Constructs an instance of FeedServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
FeedServiceSettings |
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(FeedServiceStub stub)
public static final FeedServiceClient create(FeedServiceStub stub)Constructs an instance of FeedServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FeedServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
FeedServiceStub |
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient |
|
Constructors
FeedServiceClient(FeedServiceSettings settings)
protected FeedServiceClient(FeedServiceSettings settings)Constructs an instance of FeedServiceClient, 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.
| Parameter | |
|---|---|
| Name | Description |
settings |
FeedServiceSettings |
FeedServiceClient(FeedServiceStub stub)
protected FeedServiceClient(FeedServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
FeedServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()getSettings()
public final FeedServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
FeedServiceSettings |
|
getStub()
public FeedServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
FeedServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
showFeed(CaseName parent)
public final FeedServiceClient.ShowFeedPagedResponse showFeed(CaseName parent)Show items in the feed of this case, including case emails, attachments, and comments.
Sample code:
// 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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
for (FeedItem element : feedServiceClient.showFeed(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
CaseNameRequired. The resource name of the case for which feed items should be listed. |
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient.ShowFeedPagedResponse |
|
showFeed(ShowFeedRequest request)
public final FeedServiceClient.ShowFeedPagedResponse showFeed(ShowFeedRequest request)Show items in the feed of this case, including case emails, attachments, and comments.
Sample code:
// 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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
ShowFeedRequest request =
ShowFeedRequest.newBuilder()
.setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (FeedItem element : feedServiceClient.showFeed(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ShowFeedRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient.ShowFeedPagedResponse |
|
showFeed(String parent)
public final FeedServiceClient.ShowFeedPagedResponse showFeed(String parent)Show items in the feed of this case, including case emails, attachments, and comments.
Sample code:
// 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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
String parent = CaseName.ofOrganizationCaseName("[ORGANIZATION]", "[CASE]").toString();
for (FeedItem element : feedServiceClient.showFeed(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The resource name of the case for which feed items should be listed. |
| Returns | |
|---|---|
| Type | Description |
FeedServiceClient.ShowFeedPagedResponse |
|
showFeedCallable()
public final UnaryCallable,ShowFeedResponse> showFeedCallable() Show items in the feed of this case, including case emails, attachments, and comments.
Sample code:
// 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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
ShowFeedRequest request =
ShowFeedRequest.newBuilder()
.setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ShowFeedResponse response = feedServiceClient.showFeedCallable().call(request);
for (FeedItem element : response.getFeedItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ShowFeedRequest,ShowFeedResponse> |
|
showFeedPagedCallable()
public final UnaryCallable,FeedServiceClient.ShowFeedPagedResponse> showFeedPagedCallable() Show items in the feed of this case, including case emails, attachments, and comments.
Sample code:
// 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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) {
ShowFeedRequest request =
ShowFeedRequest.newBuilder()
.setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ShowFeedRequest,ShowFeedPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()