Class TransitionRouteGroupsClient (0.43.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Service for managing TransitionRouteGroups.

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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().

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

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

See the individual methods for example code.

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

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

To customize credentials:


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

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:


 // 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.

Inheritance

java.lang.Object > TransitionRouteGroupsClient

Static Methods

create()

public static final TransitionRouteGroupsClient create()

Constructs an instance of TransitionRouteGroupsClient with default settings.

Returns
Type Description
TransitionRouteGroupsClient
Exceptions
Type Description
IOException

create(TransitionRouteGroupsSettings settings)

public static final TransitionRouteGroupsClient create(TransitionRouteGroupsSettings settings)

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.

Parameter
Name Description
settings TransitionRouteGroupsSettings
Returns
Type Description
TransitionRouteGroupsClient
Exceptions
Type Description
IOException

create(TransitionRouteGroupsStub stub)

public static final TransitionRouteGroupsClient create(TransitionRouteGroupsStub stub)

Constructs an instance of TransitionRouteGroupsClient, using the given stub for making calls. This is for advanced usage - prefer using create(TransitionRouteGroupsSettings).

Parameter
Name Description
stub TransitionRouteGroupsStub
Returns
Type Description
TransitionRouteGroupsClient

Constructors

TransitionRouteGroupsClient(TransitionRouteGroupsSettings settings)

protected TransitionRouteGroupsClient(TransitionRouteGroupsSettings settings)

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.

Parameter
Name Description
settings TransitionRouteGroupsSettings

TransitionRouteGroupsClient(TransitionRouteGroupsStub stub)

protected TransitionRouteGroupsClient(TransitionRouteGroupsStub stub)
Parameter
Name Description
stub TransitionRouteGroupsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createTransitionRouteGroup(AgentName parent, TransitionRouteGroup transitionRouteGroup)

public final TransitionRouteGroup createTransitionRouteGroup(AgentName parent, TransitionRouteGroup transitionRouteGroup)

Creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
   TransitionRouteGroup response =
       transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
 }
Parameters
Name Description
parent AgentName

Required. The flow to create an TransitionRouteGroup for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> for agent-level groups.
transitionRouteGroup TransitionRouteGroup

Required. The transition route group to create.
Returns
Type Description
TransitionRouteGroup

createTransitionRouteGroup(CreateTransitionRouteGroupRequest request)

public final TransitionRouteGroup createTransitionRouteGroup(CreateTransitionRouteGroupRequest request)

Creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameter
Name Description
request CreateTransitionRouteGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TransitionRouteGroup

createTransitionRouteGroup(FlowName parent, TransitionRouteGroup transitionRouteGroup)

public final TransitionRouteGroup createTransitionRouteGroup(FlowName parent, TransitionRouteGroup transitionRouteGroup)

Creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
   TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
   TransitionRouteGroup response =
       transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
 }
Parameters
Name Description
parent FlowName

Required. The flow to create an TransitionRouteGroup for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> for agent-level groups.
transitionRouteGroup TransitionRouteGroup

Required. The transition route group to create.
Returns
Type Description
TransitionRouteGroup

createTransitionRouteGroup(String parent, TransitionRouteGroup transitionRouteGroup)

public final TransitionRouteGroup createTransitionRouteGroup(String parent, TransitionRouteGroup transitionRouteGroup)

Creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
   TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
   TransitionRouteGroup response =
       transitionRouteGroupsClient.createTransitionRouteGroup(parent, transitionRouteGroup);
 }
Parameters
Name Description
parent String

Required. The flow to create an TransitionRouteGroup for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> for agent-level groups.
transitionRouteGroup TransitionRouteGroup

Required. The transition route group to create.
Returns
Type Description
TransitionRouteGroup

createTransitionRouteGroupCallable()

public final UnaryCallable<CreateTransitionRouteGroupRequest,TransitionRouteGroup> createTransitionRouteGroupCallable()

Creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<TransitionRouteGroup> future =
       transitionRouteGroupsClient.createTransitionRouteGroupCallable().futureCall(request);
   // Do something.
   TransitionRouteGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateTransitionRouteGroupRequest,TransitionRouteGroup>

deleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest request)

public final void deleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest request)

Deletes the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameter
Name Description
request DeleteTransitionRouteGroupRequest

The request object containing all of the parameters for the API call.

deleteTransitionRouteGroup(TransitionRouteGroupName name)

public final void deleteTransitionRouteGroup(TransitionRouteGroupName name)

Deletes the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   TransitionRouteGroupName name =
       TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
   transitionRouteGroupsClient.deleteTransitionRouteGroup(name);
 }
Parameter
Name Description
name TransitionRouteGroupName

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.

deleteTransitionRouteGroup(String name)

public final void deleteTransitionRouteGroup(String name)

Deletes the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   String name =
       TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
               "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]")
           .toString();
   transitionRouteGroupsClient.deleteTransitionRouteGroup(name);
 }
Parameter
Name Description
name String

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.

deleteTransitionRouteGroupCallable()

public final UnaryCallable<DeleteTransitionRouteGroupRequest,Empty> deleteTransitionRouteGroupCallable()

Deletes the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   DeleteTransitionRouteGroupRequest request =
       DeleteTransitionRouteGroupRequest.newBuilder()
           .setName(
               TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[AGENT]",
                       "[FLOW]",
                       "[TRANSITION_ROUTE_GROUP]")
                   .toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future =
       transitionRouteGroupsClient.deleteTransitionRouteGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteTransitionRouteGroupRequest,Empty>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = transitionRouteGroupsClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       transitionRouteGroupsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final TransitionRouteGroupsSettings getSettings()
Returns
Type Description
TransitionRouteGroupsSettings

getStub()

public TransitionRouteGroupsStub getStub()
Returns
Type Description
TransitionRouteGroupsStub

getTransitionRouteGroup(GetTransitionRouteGroupRequest request)

public final TransitionRouteGroup getTransitionRouteGroup(GetTransitionRouteGroupRequest request)

Retrieves the specified TransitionRouteGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameter
Name Description
request GetTransitionRouteGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TransitionRouteGroup

getTransitionRouteGroup(TransitionRouteGroupName name)

public final TransitionRouteGroup getTransitionRouteGroup(TransitionRouteGroupName name)

Retrieves the specified TransitionRouteGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   TransitionRouteGroupName name =
       TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
   TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
 }
Parameter
Name Description
name TransitionRouteGroupName

Required. The name of the TransitionRouteGroup. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.
Returns
Type Description
TransitionRouteGroup

getTransitionRouteGroup(String name)

public final TransitionRouteGroup getTransitionRouteGroup(String name)

Retrieves the specified TransitionRouteGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   String name =
       TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
               "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]")
           .toString();
   TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
 }
Parameter
Name Description
name String

Required. The name of the TransitionRouteGroup. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.
Returns
Type Description
TransitionRouteGroup

getTransitionRouteGroupCallable()

public final UnaryCallable<GetTransitionRouteGroupRequest,TransitionRouteGroup> getTransitionRouteGroupCallable()

Retrieves the specified TransitionRouteGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   GetTransitionRouteGroupRequest request =
       GetTransitionRouteGroupRequest.newBuilder()
           .setName(
               TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[AGENT]",
                       "[FLOW]",
                       "[TRANSITION_ROUTE_GROUP]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<TransitionRouteGroup> future =
       transitionRouteGroupsClient.getTransitionRouteGroupCallable().futureCall(request);
   // Do something.
   TransitionRouteGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTransitionRouteGroupRequest,TransitionRouteGroup>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final TransitionRouteGroupsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TransitionRouteGroupsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,TransitionRouteGroupsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       transitionRouteGroupsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listTransitionRouteGroups(AgentName parent)

public final TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(AgentName parent)

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   for (TransitionRouteGroup element :
       transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AgentName

Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse

listTransitionRouteGroups(FlowName parent)

public final TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(FlowName parent)

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
   for (TransitionRouteGroup element :
       transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent FlowName

Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse

listTransitionRouteGroups(ListTransitionRouteGroupsRequest request)

public final TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(ListTransitionRouteGroupsRequest request)

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
Parameter
Name Description
request ListTransitionRouteGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse

listTransitionRouteGroups(String parent)

public final TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse listTransitionRouteGroups(String parent)

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
   for (TransitionRouteGroup element :
       transitionRouteGroupsClient.listTransitionRouteGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID> or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse

listTransitionRouteGroupsCallable()

public final UnaryCallable<ListTransitionRouteGroupsRequest,ListTransitionRouteGroupsResponse> listTransitionRouteGroupsCallable()

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListTransitionRouteGroupsRequest,ListTransitionRouteGroupsResponse>

listTransitionRouteGroupsPagedCallable()

public final UnaryCallable<ListTransitionRouteGroupsRequest,TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse> listTransitionRouteGroupsPagedCallable()

Returns the list of all transition route groups in the specified flow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<TransitionRouteGroup> future =
       transitionRouteGroupsClient.listTransitionRouteGroupsPagedCallable().futureCall(request);
   // Do something.
   for (TransitionRouteGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTransitionRouteGroupsRequest,ListTransitionRouteGroupsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateTransitionRouteGroup(TransitionRouteGroup transitionRouteGroup, FieldMask updateMask)

public final TransitionRouteGroup updateTransitionRouteGroup(TransitionRouteGroup transitionRouteGroup, FieldMask updateMask)

Updates the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   TransitionRouteGroup transitionRouteGroup = TransitionRouteGroup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TransitionRouteGroup response =
       transitionRouteGroupsClient.updateTransitionRouteGroup(transitionRouteGroup, updateMask);
 }
Parameters
Name Description
transitionRouteGroup TransitionRouteGroup

Required. The transition route group to update.
updateMask FieldMask

The mask to control which fields get updated.
Returns
Type Description
TransitionRouteGroup

updateTransitionRouteGroup(UpdateTransitionRouteGroupRequest request)

public final TransitionRouteGroup updateTransitionRouteGroup(UpdateTransitionRouteGroupRequest request)

Updates the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameter
Name Description
request UpdateTransitionRouteGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TransitionRouteGroup

updateTransitionRouteGroupCallable()

public final UnaryCallable<UpdateTransitionRouteGroupRequest,TransitionRouteGroup> updateTransitionRouteGroupCallable()

Updates the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   UpdateTransitionRouteGroupRequest request =
       UpdateTransitionRouteGroupRequest.newBuilder()
           .setTransitionRouteGroup(TransitionRouteGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<TransitionRouteGroup> future =
       transitionRouteGroupsClient.updateTransitionRouteGroupCallable().futureCall(request);
   // Do something.
   TransitionRouteGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateTransitionRouteGroupRequest,TransitionRouteGroup>