com.google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupsClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow-cx Show documentation
Show all versions of google-cloud-dialogflow-cx Show documentation
provides a new way of designing agents, taking a state machine approach to agent design. This gives you clear and explicit control over a conversation, a better end-user experience, and a better development workflow.
The newest version!
/*
* 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.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.cx.v3beta1.stub.TransitionRouteGroupsStub;
import com.google.cloud.dialogflow.cx.v3beta1.stub.TransitionRouteGroupsStubSettings;
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 com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing
* [TransitionRouteGroups][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* TransitionRouteGroupName name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
* TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
* }
* }
*
* Note: close() needs to be called on the TransitionRouteGroupsClient 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
*
*
* ListTransitionRouteGroups
Returns the list of all transition route groups in the specified flow.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTransitionRouteGroups(ListTransitionRouteGroupsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTransitionRouteGroups(AgentName parent)
*
listTransitionRouteGroups(FlowName parent)
*
listTransitionRouteGroups(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTransitionRouteGroupsPagedCallable()
*
listTransitionRouteGroupsCallable()
*
*
*
*
* GetTransitionRouteGroup
Retrieves the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTransitionRouteGroup(GetTransitionRouteGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTransitionRouteGroup(TransitionRouteGroupName name)
*
getTransitionRouteGroup(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getTransitionRouteGroupCallable()
*
*
*
*
* CreateTransitionRouteGroup
Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in the specified flow.
*
Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTransitionRouteGroup(CreateTransitionRouteGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createTransitionRouteGroup(AgentName parent, TransitionRouteGroup transitionRouteGroup)
*
createTransitionRouteGroup(FlowName parent, TransitionRouteGroup transitionRouteGroup)
*
createTransitionRouteGroup(String parent, TransitionRouteGroup transitionRouteGroup)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTransitionRouteGroupCallable()
*
*
*
*
* UpdateTransitionRouteGroup
Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTransitionRouteGroup(UpdateTransitionRouteGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateTransitionRouteGroup(TransitionRouteGroup transitionRouteGroup, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTransitionRouteGroupCallable()
*
*
*
*
* DeleteTransitionRouteGroup
Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTransitionRouteGroup(TransitionRouteGroupName name)
*
deleteTransitionRouteGroup(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTransitionRouteGroupCallable()
*
*
*
*
* 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 TransitionRouteGroupsSettings
* 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
* TransitionRouteGroupsSettings transitionRouteGroupsSettings =
* TransitionRouteGroupsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);
* }
*
* 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
* TransitionRouteGroupsSettings transitionRouteGroupsSettings =
* TransitionRouteGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
* TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);
* }
*
* 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
* TransitionRouteGroupsSettings transitionRouteGroupsSettings =
* TransitionRouteGroupsSettings.newHttpJsonBuilder().build();
* TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class TransitionRouteGroupsClient implements BackgroundResource {
private final TransitionRouteGroupsSettings settings;
private final TransitionRouteGroupsStub stub;
/** Constructs an instance of TransitionRouteGroupsClient with default settings. */
public static final TransitionRouteGroupsClient create() throws IOException {
return create(TransitionRouteGroupsSettings.newBuilder().build());
}
/**
* Constructs an instance of TransitionRouteGroupsClient, 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 TransitionRouteGroupsClient create(TransitionRouteGroupsSettings settings)
throws IOException {
return new TransitionRouteGroupsClient(settings);
}
/**
* Constructs an instance of TransitionRouteGroupsClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(TransitionRouteGroupsSettings).
*/
public static final TransitionRouteGroupsClient create(TransitionRouteGroupsStub stub) {
return new TransitionRouteGroupsClient(stub);
}
/**
* Constructs an instance of TransitionRouteGroupsClient, 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 TransitionRouteGroupsClient(TransitionRouteGroupsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((TransitionRouteGroupsStubSettings) settings.getStubSettings()).createStub();
}
protected TransitionRouteGroupsClient(TransitionRouteGroupsStub stub) {
this.settings = null;
this.stub = stub;
}
public final TransitionRouteGroupsSettings getSettings() {
return settings;
}
public TransitionRouteGroupsStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* for (TransitionRouteGroup element :
* transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The flow to list all transition route groups for. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(AgentName parent) {
ListTransitionRouteGroupsRequest request =
ListTransitionRouteGroupsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransitionRouteGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* for (TransitionRouteGroup element :
* transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The flow to list all transition route groups for. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(FlowName parent) {
ListTransitionRouteGroupsRequest request =
ListTransitionRouteGroupsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransitionRouteGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* for (TransitionRouteGroup element :
* transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The flow to list all transition route groups for. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(String parent) {
ListTransitionRouteGroupsRequest request =
ListTransitionRouteGroupsRequest.newBuilder().setParent(parent).build();
return listTransitionRouteGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListTransitionRouteGroupsRequest request =
* ListTransitionRouteGroupsRequest.newBuilder()
* .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* for (TransitionRouteGroup element :
* transitionRouteGroupsClient.listTransitionRouteGroups(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 ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(
ListTransitionRouteGroupsRequest request) {
return listTransitionRouteGroupsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListTransitionRouteGroupsRequest request =
* ListTransitionRouteGroupsRequest.newBuilder()
* .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.listTransitionRouteGroupsPagedCallable().futureCall(request);
* // Do something.
* for (TransitionRouteGroup element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable<
ListTransitionRouteGroupsRequest, ListTransitionRouteGroupsPagedResponse>
listTransitionRouteGroupsPagedCallable() {
return stub.listTransitionRouteGroupsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all transition route groups in the specified flow.
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListTransitionRouteGroupsRequest request =
* ListTransitionRouteGroupsRequest.newBuilder()
* .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* while (true) {
* ListTransitionRouteGroupsResponse response =
* transitionRouteGroupsClient.listTransitionRouteGroupsCallable().call(request);
* for (TransitionRouteGroup element : response.getTransitionRouteGroupsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTransitionRouteGroupsCallable() {
return stub.listTransitionRouteGroupsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* TransitionRouteGroupName name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
* TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
* }
* }
*
* @param name Required. The name of the
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup getTransitionRouteGroup(TransitionRouteGroupName name) {
GetTransitionRouteGroupRequest request =
GetTransitionRouteGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* String name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]")
* .toString();
* TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
* }
* }
*
* @param name Required. The name of the
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup getTransitionRouteGroup(String name) {
GetTransitionRouteGroupRequest request =
GetTransitionRouteGroupRequest.newBuilder().setName(name).build();
return getTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* GetTransitionRouteGroupRequest request =
* GetTransitionRouteGroupRequest.newBuilder()
* .setName(
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]",
* "[LOCATION]",
* "[AGENT]",
* "[FLOW]",
* "[TRANSITION_ROUTE_GROUP]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(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 TransitionRouteGroup getTransitionRouteGroup(
GetTransitionRouteGroupRequest request) {
return getTransitionRouteGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* GetTransitionRouteGroupRequest request =
* GetTransitionRouteGroupRequest.newBuilder()
* .setName(
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]",
* "[LOCATION]",
* "[AGENT]",
* "[FLOW]",
* "[TRANSITION_ROUTE_GROUP]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.getTransitionRouteGroupCallable().futureCall(request);
* // Do something.
* TransitionRouteGroup response = future.get();
* }
* }
*/
public final UnaryCallable
getTransitionRouteGroupCallable() {
return stub.getTransitionRouteGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in
* the specified flow.
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
* }
* }
*
* @param parent Required. The flow to create an
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] for.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>` for
* agent-level groups.
* @param transitionRouteGroup Required. The transition route group to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup createTransitionRouteGroup(
AgentName parent, TransitionRouteGroup transitionRouteGroup) {
CreateTransitionRouteGroupRequest request =
CreateTransitionRouteGroupRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTransitionRouteGroup(transitionRouteGroup)
.build();
return createTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in
* the specified flow.
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
* }
* }
*
* @param parent Required. The flow to create an
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] for.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>` for
* agent-level groups.
* @param transitionRouteGroup Required. The transition route group to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup createTransitionRouteGroup(
FlowName parent, TransitionRouteGroup transitionRouteGroup) {
CreateTransitionRouteGroupRequest request =
CreateTransitionRouteGroupRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTransitionRouteGroup(transitionRouteGroup)
.build();
return createTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in
* the specified flow.
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
* }
* }
*
* @param parent Required. The flow to create an
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] for.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
* or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>` for
* agent-level groups.
* @param transitionRouteGroup Required. The transition route group to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup createTransitionRouteGroup(
String parent, TransitionRouteGroup transitionRouteGroup) {
CreateTransitionRouteGroupRequest request =
CreateTransitionRouteGroupRequest.newBuilder()
.setParent(parent)
.setTransitionRouteGroup(transitionRouteGroup)
.build();
return createTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in
* the specified flow.
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* CreateTransitionRouteGroupRequest request =
* CreateTransitionRouteGroupRequest.newBuilder()
* .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setTransitionRouteGroup(TransitionRouteGroup.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.createTransitionRouteGroup(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 TransitionRouteGroup createTransitionRouteGroup(
CreateTransitionRouteGroupRequest request) {
return createTransitionRouteGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in
* the specified flow.
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* CreateTransitionRouteGroupRequest request =
* CreateTransitionRouteGroupRequest.newBuilder()
* .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setTransitionRouteGroup(TransitionRouteGroup.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.createTransitionRouteGroupCallable().futureCall(request);
* // Do something.
* TransitionRouteGroup response = future.get();
* }
* }
*/
public final UnaryCallable
createTransitionRouteGroupCallable() {
return stub.createTransitionRouteGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.updateTransitionRouteGroup(transitionRouteGroup, updateMask);
* }
* }
*
* @param transitionRouteGroup Required. The transition route group to update.
* @param updateMask The mask to control which fields get updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransitionRouteGroup updateTransitionRouteGroup(
TransitionRouteGroup transitionRouteGroup, FieldMask updateMask) {
UpdateTransitionRouteGroupRequest request =
UpdateTransitionRouteGroupRequest.newBuilder()
.setTransitionRouteGroup(transitionRouteGroup)
.setUpdateMask(updateMask)
.build();
return updateTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* UpdateTransitionRouteGroupRequest request =
* UpdateTransitionRouteGroupRequest.newBuilder()
* .setTransitionRouteGroup(TransitionRouteGroup.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* TransitionRouteGroup response =
* transitionRouteGroupsClient.updateTransitionRouteGroup(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 TransitionRouteGroup updateTransitionRouteGroup(
UpdateTransitionRouteGroupRequest request) {
return updateTransitionRouteGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* UpdateTransitionRouteGroupRequest request =
* UpdateTransitionRouteGroupRequest.newBuilder()
* .setTransitionRouteGroup(TransitionRouteGroup.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.updateTransitionRouteGroupCallable().futureCall(request);
* // Do something.
* TransitionRouteGroup response = future.get();
* }
* }
*/
public final UnaryCallable
updateTransitionRouteGroupCallable() {
return stub.updateTransitionRouteGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* TransitionRouteGroupName name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
* transitionRouteGroupsClient.deleteTransitionRouteGroup(name);
* }
* }
*
* @param name Required. The name of the
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] to delete.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransitionRouteGroup(TransitionRouteGroupName name) {
DeleteTransitionRouteGroupRequest request =
DeleteTransitionRouteGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* String name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]")
* .toString();
* transitionRouteGroupsClient.deleteTransitionRouteGroup(name);
* }
* }
*
* @param name Required. The name of the
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] to delete.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransitionRouteGroup(String name) {
DeleteTransitionRouteGroupRequest request =
DeleteTransitionRouteGroupRequest.newBuilder().setName(name).build();
deleteTransitionRouteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* DeleteTransitionRouteGroupRequest request =
* DeleteTransitionRouteGroupRequest.newBuilder()
* .setName(
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]",
* "[LOCATION]",
* "[AGENT]",
* "[FLOW]",
* "[TRANSITION_ROUTE_GROUP]")
* .toString())
* .setForce(true)
* .build();
* transitionRouteGroupsClient.deleteTransitionRouteGroup(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 void deleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest request) {
deleteTransitionRouteGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified
* [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
*
* Note: You should always train a flow prior to sending it queries. See the [training
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
*
*
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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* DeleteTransitionRouteGroupRequest request =
* DeleteTransitionRouteGroupRequest.newBuilder()
* .setName(
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]",
* "[LOCATION]",
* "[AGENT]",
* "[FLOW]",
* "[TRANSITION_ROUTE_GROUP]")
* .toString())
* .setForce(true)
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.deleteTransitionRouteGroupCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteTransitionRouteGroupCallable() {
return stub.deleteTransitionRouteGroupCallable();
}
// 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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : transitionRouteGroupsClient.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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* transitionRouteGroupsClient.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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response =
* transitionRouteGroupsClient.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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = transitionRouteGroupsClient.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 (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* transitionRouteGroupsClient.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 ListTransitionRouteGroupsPagedResponse
extends AbstractPagedListResponse<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup,
ListTransitionRouteGroupsPage,
ListTransitionRouteGroupsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTransitionRouteGroupsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTransitionRouteGroupsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTransitionRouteGroupsPagedResponse(ListTransitionRouteGroupsPage page) {
super(page, ListTransitionRouteGroupsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTransitionRouteGroupsPage
extends AbstractPage<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup,
ListTransitionRouteGroupsPage> {
private ListTransitionRouteGroupsPage(
PageContext<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup>
context,
ListTransitionRouteGroupsResponse response) {
super(context, response);
}
private static ListTransitionRouteGroupsPage createEmptyPage() {
return new ListTransitionRouteGroupsPage(null, null);
}
@Override
protected ListTransitionRouteGroupsPage createPage(
PageContext<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup>
context,
ListTransitionRouteGroupsResponse response) {
return new ListTransitionRouteGroupsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTransitionRouteGroupsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTransitionRouteGroupsRequest,
ListTransitionRouteGroupsResponse,
TransitionRouteGroup,
ListTransitionRouteGroupsPage,
ListTransitionRouteGroupsFixedSizeCollection> {
private ListTransitionRouteGroupsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTransitionRouteGroupsFixedSizeCollection createEmptyCollection() {
return new ListTransitionRouteGroupsFixedSizeCollection(null, 0);
}
@Override
protected ListTransitionRouteGroupsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTransitionRouteGroupsFixedSizeCollection(pages, collectionSize);
}
}
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);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy