com.google.cloud.dialogflow.cx.v3beta1.SessionsClient Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow-cx Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.cx.v3beta1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.BidiStreamingCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.cx.v3beta1.stub.SessionsStub;
import com.google.cloud.dialogflow.cx.v3beta1.stub.SessionsStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: A session represents an interaction with a user. You retrieve user input and
* pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent] method to
* determine user intent and respond.
*
* 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:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* DetectIntentRequest request =
* DetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* DetectIntentResponse response = sessionsClient.detectIntent(request);
* }
* }
*
* Note: close() needs to be called on the SessionsClient object to clean up resources such as
* threads. In the example above, try-with-resources is used, which automatically calls close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* DetectIntent
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.
*
Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* detectIntent(DetectIntentRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* detectIntentCallable()
*
*
*
*
* ServerStreamingDetectIntent
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* serverStreamingDetectIntentCallable()
*
*
*
*
* StreamingDetectIntent
Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
*
Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* streamingDetectIntentCallable()
*
*
*
*
* MatchIntent
Returns preliminary intent match results, doesn't change the session status.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* matchIntent(MatchIntentRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* matchIntentCallable()
*
*
*
*
* FulfillIntent
Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent]. Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse]. Otherwise, the behavior is undefined.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* fulfillIntent(FulfillIntentRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* fulfillIntentCallable()
*
*
*
*
* SubmitAnswerFeedback
Updates the feedback received from the user for a single turn of the bot response.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* submitAnswerFeedback(SubmitAnswerFeedbackRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* submitAnswerFeedbackCallable()
*
*
*
*
* ListLocations
Lists information about the supported locations for this service.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listLocations(ListLocationsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listLocationsPagedCallable()
*
listLocationsCallable()
*
*
*
*
* GetLocation
Gets information about a location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getLocation(GetLocationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getLocationCallable()
*
*
*
*
*
* 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 SessionsSettings to create().
* For example:
*
*
To customize credentials:
*
*
{@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
* SessionsSettings sessionsSettings =
* SessionsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* SessionsSettings sessionsSettings =
* SessionsSettings.newBuilder().setEndpoint(myEndpoint).build();
* SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* SessionsSettings sessionsSettings = SessionsSettings.newHttpJsonBuilder().build();
* SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class SessionsClient implements BackgroundResource {
private final SessionsSettings settings;
private final SessionsStub stub;
/** Constructs an instance of SessionsClient with default settings. */
public static final SessionsClient create() throws IOException {
return create(SessionsSettings.newBuilder().build());
}
/**
* Constructs an instance of SessionsClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final SessionsClient create(SessionsSettings settings) throws IOException {
return new SessionsClient(settings);
}
/**
* Constructs an instance of SessionsClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(SessionsSettings).
*/
public static final SessionsClient create(SessionsStub stub) {
return new SessionsClient(stub);
}
/**
* Constructs an instance of SessionsClient, 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.
*/
protected SessionsClient(SessionsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SessionsStubSettings) settings.getStubSettings()).createStub();
}
protected SessionsClient(SessionsStub stub) {
this.settings = null;
this.stub = stub;
}
public final SessionsSettings getSettings() {
return settings;
}
public SessionsStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Processes a natural language query and returns structured, actionable data as a result. This
* method is not idempotent, because it may cause session entity types to be updated, which in
* turn might affect results of future queries.
*
*
Note: Always use agent versions for production traffic. See [Versions and
* environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
*
*
Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* DetectIntentRequest request =
* DetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* DetectIntentResponse response = sessionsClient.detectIntent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DetectIntentResponse detectIntent(DetectIntentRequest request) {
return detectIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Processes a natural language query and returns structured, actionable data as a result. This
* method is not idempotent, because it may cause session entity types to be updated, which in
* turn might affect results of future queries.
*
* Note: Always use agent versions for production traffic. See [Versions and
* environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
*
*
Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* DetectIntentRequest request =
* DetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* ApiFuture future =
* sessionsClient.detectIntentCallable().futureCall(request);
* // Do something.
* DetectIntentResponse response = future.get();
* }
* }
*/
public final UnaryCallable detectIntentCallable() {
return stub.detectIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Processes a natural language query and returns structured, actionable data as a result through
* server-side streaming. Server-side streaming allows Dialogflow to send [partial
* responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response)
* earlier in a single request.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* DetectIntentRequest request =
* DetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* ServerStream stream =
* sessionsClient.serverStreamingDetectIntentCallable().call(request);
* for (DetectIntentResponse response : stream) {
* // Do something when a response is received.
* }
* }
* }
*/
public final ServerStreamingCallable
serverStreamingDetectIntentCallable() {
return stub.serverStreamingDetectIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Processes a natural language query in audio format in a streaming fashion and returns
* structured, actionable data as a result. This method is only available via the gRPC API (not
* REST).
*
* Note: Always use agent versions for production traffic. See [Versions and
* environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
*
*
Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* BidiStream bidiStream =
* sessionsClient.streamingDetectIntentCallable().call();
* StreamingDetectIntentRequest request =
* StreamingDetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .setEnablePartialResponse(true)
* .setEnableDebuggingInfo(true)
* .build();
* bidiStream.send(request);
* for (StreamingDetectIntentResponse response : bidiStream) {
* // Do something when a response is received.
* }
* }
* }
*/
public final BidiStreamingCallable
streamingDetectIntentCallable() {
return stub.streamingDetectIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns preliminary intent match results, doesn't change the session status.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* MatchIntentRequest request =
* MatchIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setPersistParameterChanges(true)
* .build();
* MatchIntentResponse response = sessionsClient.matchIntent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MatchIntentResponse matchIntent(MatchIntentRequest request) {
return matchIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns preliminary intent match results, doesn't change the session status.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* MatchIntentRequest request =
* MatchIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setPersistParameterChanges(true)
* .build();
* ApiFuture future =
* sessionsClient.matchIntentCallable().futureCall(request);
* // Do something.
* MatchIntentResponse response = future.get();
* }
* }
*/
public final UnaryCallable matchIntentCallable() {
return stub.matchIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fulfills a matched intent returned by
* [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent]. Must be called after
* [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent], with input from
* [MatchIntentResponse][google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse]. Otherwise, the
* behavior is undefined.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* FulfillIntentRequest request =
* FulfillIntentRequest.newBuilder()
* .setMatchIntentRequest(MatchIntentRequest.newBuilder().build())
* .setMatch(Match.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* FulfillIntentResponse response = sessionsClient.fulfillIntent(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final FulfillIntentResponse fulfillIntent(FulfillIntentRequest request) {
return fulfillIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fulfills a matched intent returned by
* [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent]. Must be called after
* [MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent], with input from
* [MatchIntentResponse][google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse]. Otherwise, the
* behavior is undefined.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* FulfillIntentRequest request =
* FulfillIntentRequest.newBuilder()
* .setMatchIntentRequest(MatchIntentRequest.newBuilder().build())
* .setMatch(Match.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* ApiFuture future =
* sessionsClient.fulfillIntentCallable().futureCall(request);
* // Do something.
* FulfillIntentResponse response = future.get();
* }
* }
*/
public final UnaryCallable fulfillIntentCallable() {
return stub.fulfillIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the feedback received from the user for a single turn of the bot response.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* SubmitAnswerFeedbackRequest request =
* SubmitAnswerFeedbackRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setResponseId("responseId-633138884")
* .setAnswerFeedback(AnswerFeedback.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* AnswerFeedback response = sessionsClient.submitAnswerFeedback(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnswerFeedback submitAnswerFeedback(SubmitAnswerFeedbackRequest request) {
return submitAnswerFeedbackCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the feedback received from the user for a single turn of the bot response.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* SubmitAnswerFeedbackRequest request =
* SubmitAnswerFeedbackRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setResponseId("responseId-633138884")
* .setAnswerFeedback(AnswerFeedback.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* sessionsClient.submitAnswerFeedbackCallable().futureCall(request);
* // Do something.
* AnswerFeedback response = future.get();
* }
* }
*/
public final UnaryCallable
submitAnswerFeedbackCallable() {
return stub.submitAnswerFeedbackCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : sessionsClient.listLocations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future = sessionsClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = sessionsClient.listLocationsCallable().call(request);
* for (Location element : response.getLocationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = sessionsClient.getLocation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (SessionsClient sessionsClient = SessionsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = sessionsClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}