com.google.cloud.dialogflow.cx.v3.FlowsClient Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow-cx Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.cx.v3;
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.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
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.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.cx.v3.stub.FlowsStub;
import com.google.cloud.dialogflow.cx.v3.stub.FlowsStubSettings;
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.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import com.google.protobuf.Struct;
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 [Flows][google.cloud.dialogflow.cx.v3.Flow].
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* Flow flow = Flow.newBuilder().build();
* Flow response = flowsClient.createFlow(parent, flow);
* }
* }
*
* Note: close() needs to be called on the FlowsClient 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
*
*
* CreateFlow
Creates a flow in the specified agent.
*
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.
*
* createFlow(CreateFlowRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createFlow(AgentName parent, Flow flow)
*
createFlow(String parent, Flow flow)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createFlowCallable()
*
*
*
*
* DeleteFlow
Deletes a specified flow.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteFlow(DeleteFlowRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteFlow(FlowName name)
*
deleteFlow(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.
*
* deleteFlowCallable()
*
*
*
*
* ListFlows
Returns the list of all flows in the specified agent.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listFlows(ListFlowsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listFlows(AgentName parent)
*
listFlows(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.
*
* listFlowsPagedCallable()
*
listFlowsCallable()
*
*
*
*
* GetFlow
Retrieves the specified flow.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getFlow(GetFlowRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getFlow(FlowName name)
*
getFlow(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.
*
* getFlowCallable()
*
*
*
*
* UpdateFlow
Updates 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.
*
* updateFlow(UpdateFlowRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateFlow(Flow flow, 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.
*
* updateFlowCallable()
*
*
*
*
* TrainFlow
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
*
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
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.
*
* trainFlowAsync(TrainFlowRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* trainFlowAsync(FlowName name)
*
trainFlowAsync(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.
*
* trainFlowOperationCallable()
*
trainFlowCallable()
*
*
*
*
* ValidateFlow
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* validateFlow(ValidateFlowRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* validateFlowCallable()
*
*
*
*
* GetFlowValidationResult
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getFlowValidationResult(GetFlowValidationResultRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getFlowValidationResult(FlowValidationResultName name)
*
getFlowValidationResult(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.
*
* getFlowValidationResultCallable()
*
*
*
*
* ImportFlow
Imports the specified flow to the specified agent from a binary file.
*
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
*
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
*
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.
*
* importFlowAsync(ImportFlowRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* importFlowOperationCallable()
*
importFlowCallable()
*
*
*
*
* ExportFlow
Exports the specified flow to a binary file.
*
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
*
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
*
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* exportFlowAsync(ExportFlowRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* exportFlowOperationCallable()
*
exportFlowCallable()
*
*
*
*
* 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 FlowsSettings 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
* FlowsSettings flowsSettings =
* FlowsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* FlowsClient flowsClient = FlowsClient.create(flowsSettings);
* }
*
* 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
* FlowsSettings flowsSettings = FlowsSettings.newBuilder().setEndpoint(myEndpoint).build();
* FlowsClient flowsClient = FlowsClient.create(flowsSettings);
* }
*
* 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
* FlowsSettings flowsSettings = FlowsSettings.newHttpJsonBuilder().build();
* FlowsClient flowsClient = FlowsClient.create(flowsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class FlowsClient implements BackgroundResource {
private final FlowsSettings settings;
private final FlowsStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of FlowsClient with default settings. */
public static final FlowsClient create() throws IOException {
return create(FlowsSettings.newBuilder().build());
}
/**
* Constructs an instance of FlowsClient, 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 FlowsClient create(FlowsSettings settings) throws IOException {
return new FlowsClient(settings);
}
/**
* Constructs an instance of FlowsClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(FlowsSettings).
*/
public static final FlowsClient create(FlowsStub stub) {
return new FlowsClient(stub);
}
/**
* Constructs an instance of FlowsClient, 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 FlowsClient(FlowsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((FlowsStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected FlowsClient(FlowsStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final FlowsSettings getSettings() {
return settings;
}
public FlowsStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a flow in the specified agent.
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* Flow flow = Flow.newBuilder().build();
* Flow response = flowsClient.createFlow(parent, flow);
* }
* }
*
* @param parent Required. The agent to create a flow for. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @param flow Required. The flow to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow createFlow(AgentName parent, Flow flow) {
CreateFlowRequest request =
CreateFlowRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setFlow(flow)
.build();
return createFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a flow in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
* Flow flow = Flow.newBuilder().build();
* Flow response = flowsClient.createFlow(parent, flow);
* }
* }
*
* @param parent Required. The agent to create a flow for. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @param flow Required. The flow to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow createFlow(String parent, Flow flow) {
CreateFlowRequest request =
CreateFlowRequest.newBuilder().setParent(parent).setFlow(flow).build();
return createFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a flow in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* CreateFlowRequest request =
* CreateFlowRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setFlow(Flow.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* Flow response = flowsClient.createFlow(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 Flow createFlow(CreateFlowRequest request) {
return createFlowCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a flow in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* CreateFlowRequest request =
* CreateFlowRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setFlow(Flow.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future = flowsClient.createFlowCallable().futureCall(request);
* // Do something.
* Flow response = future.get();
* }
* }
*/
public final UnaryCallable createFlowCallable() {
return stub.createFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a 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 (FlowsClient flowsClient = FlowsClient.create()) {
* FlowName name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* flowsClient.deleteFlow(name);
* }
* }
*
* @param name Required. The name of the flow to delete. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteFlow(FlowName name) {
DeleteFlowRequest request =
DeleteFlowRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a 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 (FlowsClient flowsClient = FlowsClient.create()) {
* String name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* flowsClient.deleteFlow(name);
* }
* }
*
* @param name Required. The name of the flow to delete. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteFlow(String name) {
DeleteFlowRequest request = DeleteFlowRequest.newBuilder().setName(name).build();
deleteFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a 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 (FlowsClient flowsClient = FlowsClient.create()) {
* DeleteFlowRequest request =
* DeleteFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setForce(true)
* .build();
* flowsClient.deleteFlow(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 deleteFlow(DeleteFlowRequest request) {
deleteFlowCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a 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 (FlowsClient flowsClient = FlowsClient.create()) {
* DeleteFlowRequest request =
* DeleteFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setForce(true)
* .build();
* ApiFuture future = flowsClient.deleteFlowCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteFlowCallable() {
return stub.deleteFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all flows in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* for (Flow element : flowsClient.listFlows(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The agent containing the flows. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFlowsPagedResponse listFlows(AgentName parent) {
ListFlowsRequest request =
ListFlowsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return listFlows(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all flows in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
* for (Flow element : flowsClient.listFlows(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The agent containing the flows. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFlowsPagedResponse listFlows(String parent) {
ListFlowsRequest request = ListFlowsRequest.newBuilder().setParent(parent).build();
return listFlows(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all flows in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListFlowsRequest request =
* ListFlowsRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* for (Flow element : flowsClient.listFlows(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 ListFlowsPagedResponse listFlows(ListFlowsRequest request) {
return listFlowsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all flows in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListFlowsRequest request =
* ListFlowsRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future = flowsClient.listFlowsPagedCallable().futureCall(request);
* // Do something.
* for (Flow element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable listFlowsPagedCallable() {
return stub.listFlowsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all flows in the specified agent.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListFlowsRequest request =
* ListFlowsRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .build();
* while (true) {
* ListFlowsResponse response = flowsClient.listFlowsCallable().call(request);
* for (Flow element : response.getFlowsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listFlowsCallable() {
return stub.listFlowsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves 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 (FlowsClient flowsClient = FlowsClient.create()) {
* FlowName name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* Flow response = flowsClient.getFlow(name);
* }
* }
*
* @param name Required. The name of the flow to get. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow getFlow(FlowName name) {
GetFlowRequest request =
GetFlowRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves 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 (FlowsClient flowsClient = FlowsClient.create()) {
* String name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* Flow response = flowsClient.getFlow(name);
* }
* }
*
* @param name Required. The name of the flow to get. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow getFlow(String name) {
GetFlowRequest request = GetFlowRequest.newBuilder().setName(name).build();
return getFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves 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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetFlowRequest request =
* GetFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* Flow response = flowsClient.getFlow(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 Flow getFlow(GetFlowRequest request) {
return getFlowCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves 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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetFlowRequest request =
* GetFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future = flowsClient.getFlowCallable().futureCall(request);
* // Do something.
* Flow response = future.get();
* }
* }
*/
public final UnaryCallable getFlowCallable() {
return stub.getFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates 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 (FlowsClient flowsClient = FlowsClient.create()) {
* Flow flow = Flow.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Flow response = flowsClient.updateFlow(flow, updateMask);
* }
* }
*
* @param flow Required. The flow to update.
* @param updateMask The mask to control which fields get updated. If the mask is not present, all
* fields will be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow updateFlow(Flow flow, FieldMask updateMask) {
UpdateFlowRequest request =
UpdateFlowRequest.newBuilder().setFlow(flow).setUpdateMask(updateMask).build();
return updateFlow(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates 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 (FlowsClient flowsClient = FlowsClient.create()) {
* UpdateFlowRequest request =
* UpdateFlowRequest.newBuilder()
* .setFlow(Flow.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* Flow response = flowsClient.updateFlow(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 Flow updateFlow(UpdateFlowRequest request) {
return updateFlowCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates 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 (FlowsClient flowsClient = FlowsClient.create()) {
* UpdateFlowRequest request =
* UpdateFlowRequest.newBuilder()
* .setFlow(Flow.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future = flowsClient.updateFlowCallable().futureCall(request);
* // Do something.
* Flow response = future.get();
* }
* }
*/
public final UnaryCallable updateFlowCallable() {
return stub.updateFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* FlowName name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* flowsClient.trainFlowAsync(name).get();
* }
* }
*
* @param name Required. The flow to train. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainFlowAsync(FlowName name) {
TrainFlowRequest request =
TrainFlowRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return trainFlowAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* String name = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* flowsClient.trainFlowAsync(name).get();
* }
* }
*
* @param name Required. The flow to train. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture trainFlowAsync(String name) {
TrainFlowRequest request = TrainFlowRequest.newBuilder().setName(name).build();
return trainFlowAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* TrainFlowRequest request =
* TrainFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .build();
* flowsClient.trainFlowAsync(request).get();
* }
* }
*
* @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 OperationFuture trainFlowAsync(TrainFlowRequest request) {
return trainFlowOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* TrainFlowRequest request =
* TrainFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .build();
* OperationFuture future =
* flowsClient.trainFlowOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable trainFlowOperationCallable() {
return stub.trainFlowOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Trains the specified flow. Note that only the flow in 'draft' environment is trained.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: An [Empty
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* TrainFlowRequest request =
* TrainFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .build();
* ApiFuture future = flowsClient.trainFlowCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable trainFlowCallable() {
return stub.trainFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Validates the specified flow and creates or updates validation results. Please call this API
* after the training is completed to get the complete validation results.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ValidateFlowRequest request =
* ValidateFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* FlowValidationResult response = flowsClient.validateFlow(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 FlowValidationResult validateFlow(ValidateFlowRequest request) {
return validateFlowCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Validates the specified flow and creates or updates validation results. Please call this API
* after the training is completed to get the complete validation results.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ValidateFlowRequest request =
* ValidateFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* flowsClient.validateFlowCallable().futureCall(request);
* // Do something.
* FlowValidationResult response = future.get();
* }
* }
*/
public final UnaryCallable validateFlowCallable() {
return stub.validateFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the latest flow validation result. Flow validation is performed when ValidateFlow is
* called.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* FlowValidationResultName name =
* FlowValidationResultName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
* FlowValidationResult response = flowsClient.getFlowValidationResult(name);
* }
* }
*
* @param name Required. The flow name. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/validationResult`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final FlowValidationResult getFlowValidationResult(FlowValidationResultName name) {
GetFlowValidationResultRequest request =
GetFlowValidationResultRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getFlowValidationResult(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the latest flow validation result. Flow validation is performed when ValidateFlow is
* called.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* String name =
* FlowValidationResultName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
* FlowValidationResult response = flowsClient.getFlowValidationResult(name);
* }
* }
*
* @param name Required. The flow name. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/validationResult`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final FlowValidationResult getFlowValidationResult(String name) {
GetFlowValidationResultRequest request =
GetFlowValidationResultRequest.newBuilder().setName(name).build();
return getFlowValidationResult(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the latest flow validation result. Flow validation is performed when ValidateFlow is
* called.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetFlowValidationResultRequest request =
* GetFlowValidationResultRequest.newBuilder()
* .setName(
* FlowValidationResultName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* FlowValidationResult response = flowsClient.getFlowValidationResult(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 FlowValidationResult getFlowValidationResult(
GetFlowValidationResultRequest request) {
return getFlowValidationResultCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the latest flow validation result. Flow validation is performed when ValidateFlow is
* called.
*
* 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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetFlowValidationResultRequest request =
* GetFlowValidationResultRequest.newBuilder()
* .setName(
* FlowValidationResultName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]")
* .toString())
* .setLanguageCode("languageCode-2092349083")
* .build();
* ApiFuture future =
* flowsClient.getFlowValidationResultCallable().futureCall(request);
* // Do something.
* FlowValidationResult response = future.get();
* }
* }
*/
public final UnaryCallable
getFlowValidationResultCallable() {
return stub.getFlowValidationResultCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified flow to the specified agent from a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ImportFlowRequest request =
* ImportFlowRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setFlowImportStrategy(FlowImportStrategy.newBuilder().build())
* .build();
* ImportFlowResponse response = flowsClient.importFlowAsync(request).get();
* }
* }
*
* @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 OperationFuture importFlowAsync(
ImportFlowRequest request) {
return importFlowOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified flow to the specified agent from a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ImportFlowRequest request =
* ImportFlowRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setFlowImportStrategy(FlowImportStrategy.newBuilder().build())
* .build();
* OperationFuture future =
* flowsClient.importFlowOperationCallable().futureCall(request);
* // Do something.
* ImportFlowResponse response = future.get();
* }
* }
*/
public final OperationCallable
importFlowOperationCallable() {
return stub.importFlowOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports the specified flow to the specified agent from a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ImportFlowRequest request =
* ImportFlowRequest.newBuilder()
* .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
* .setFlowImportStrategy(FlowImportStrategy.newBuilder().build())
* .build();
* ApiFuture future = flowsClient.importFlowCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable importFlowCallable() {
return stub.importFlowCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified flow to a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
*
*
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be
* exported.
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ExportFlowRequest request =
* ExportFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setFlowUri("flowUri-765815458")
* .setIncludeReferencedFlows(true)
* .build();
* ExportFlowResponse response = flowsClient.exportFlowAsync(request).get();
* }
* }
*
* @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 OperationFuture exportFlowAsync(
ExportFlowRequest request) {
return exportFlowOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified flow to a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
*
*
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be
* exported.
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ExportFlowRequest request =
* ExportFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setFlowUri("flowUri-765815458")
* .setIncludeReferencedFlows(true)
* .build();
* OperationFuture future =
* flowsClient.exportFlowOperationCallable().futureCall(request);
* // Do something.
* ExportFlowResponse response = future.get();
* }
* }
*/
public final OperationCallable
exportFlowOperationCallable() {
return stub.exportFlowOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified flow to a binary file.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
*
- `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
*
*
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be
* exported.
*
*
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 (FlowsClient flowsClient = FlowsClient.create()) {
* ExportFlowRequest request =
* ExportFlowRequest.newBuilder()
* .setName(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
* .setFlowUri("flowUri-765815458")
* .setIncludeReferencedFlows(true)
* .build();
* ApiFuture future = flowsClient.exportFlowCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable exportFlowCallable() {
return stub.exportFlowCallable();
}
// 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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : flowsClient.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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future = flowsClient.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 (FlowsClient flowsClient = FlowsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = flowsClient.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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = flowsClient.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 (FlowsClient flowsClient = FlowsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = flowsClient.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 ListFlowsPagedResponse
extends AbstractPagedListResponse<
ListFlowsRequest, ListFlowsResponse, Flow, ListFlowsPage, ListFlowsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListFlowsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListFlowsPagedResponse(input), MoreExecutors.directExecutor());
}
private ListFlowsPagedResponse(ListFlowsPage page) {
super(page, ListFlowsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListFlowsPage
extends AbstractPage {
private ListFlowsPage(
PageContext context,
ListFlowsResponse response) {
super(context, response);
}
private static ListFlowsPage createEmptyPage() {
return new ListFlowsPage(null, null);
}
@Override
protected ListFlowsPage createPage(
PageContext context,
ListFlowsResponse response) {
return new ListFlowsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListFlowsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListFlowsRequest, ListFlowsResponse, Flow, ListFlowsPage, ListFlowsFixedSizeCollection> {
private ListFlowsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListFlowsFixedSizeCollection createEmptyCollection() {
return new ListFlowsFixedSizeCollection(null, 0);
}
@Override
protected ListFlowsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListFlowsFixedSizeCollection(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);
}
}
}