com.google.cloud.dialogflow.v2.IntentsClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow Show documentation
Show all versions of google-cloud-dialogflow Show documentation
Java idiomatic client for Google Cloud Dialog Flow API
/*
* Copyright 2019 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.v2;
import com.google.api.core.ApiFunction;
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.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.v2.stub.IntentsStub;
import com.google.cloud.dialogflow.v2.stub.IntentsStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
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 SERVICE
/**
* Service Description: An intent represents a mapping between input from a user and an action to be
* taken by your application. When you pass user input to the
* [DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
* [StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method, the
* Dialogflow API analyzes the input and searches for a matching intent. If no match is found, the
* Dialogflow API returns a fallback intent (`is_fallback` = true).
*
* You can provide additional information for the Dialogflow API to use to match user input to an
* intent by adding the following to your intent.
*
*
* **Contexts** - provide additional context for intent analysis. For
* example, if an intent is related to an object in your application that plays music, you can
* provide a context to determine when to match the intent if the user input is "turn it off". You
* can include a context that matches the intent when there is previous user input of "play music",
* and not when there is previous user input of "turn on the light".
*
*
* **Events** - allow for matching an intent by using an event name instead
* of user input. Your application can provide an event name and related parameters to the
* Dialogflow API to match an intent. For example, when your application starts, you can send a
* welcome event with a user name parameter to the Dialogflow API to match an intent with a
* personalized welcome message for the user.
*
*
* **Training phrases** - provide examples of user input to train the
* Dialogflow API agent to better match intents.
*
*
For more information about intents, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow-enterprise/docs/intents-overview).
*
*
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:
*
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* Intent response = intentsClient.getIntent(name);
* }
*
*
*
* Note: close() needs to be called on the intentsClient 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:
*
*
* - 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.
*
- 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.
*
- 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 IntentsSettings to create().
* For example:
*
*
To customize credentials:
*
*
*
* IntentsSettings intentsSettings =
* IntentsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* IntentsClient intentsClient =
* IntentsClient.create(intentsSettings);
*
*
*
* To customize the endpoint:
*
*
*
* IntentsSettings intentsSettings =
* IntentsSettings.newBuilder().setEndpoint(myEndpoint).build();
* IntentsClient intentsClient =
* IntentsClient.create(intentsSettings);
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class IntentsClient implements BackgroundResource {
private final IntentsSettings settings;
private final IntentsStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of IntentsClient with default settings. */
public static final IntentsClient create() throws IOException {
return create(IntentsSettings.newBuilder().build());
}
/**
* Constructs an instance of IntentsClient, 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 IntentsClient create(IntentsSettings settings) throws IOException {
return new IntentsClient(settings);
}
/**
* Constructs an instance of IntentsClient, using the given stub for making calls. This is for
* advanced usage - prefer to use IntentsSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final IntentsClient create(IntentsStub stub) {
return new IntentsClient(stub);
}
/**
* Constructs an instance of IntentsClient, 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 IntentsClient(IntentsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((IntentsStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected IntentsClient(IntentsStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final IntentsSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public IntentsStub 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.
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The agent to list all intents from. Format: `projects/<Project
* ID>/agent`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListIntentsPagedResponse listIntents(ProjectAgentName parent) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listIntents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* for (Intent element : intentsClient.listIntents(parent.toString()).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The agent to list all intents from. Format: `projects/<Project
* ID>/agent`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListIntentsPagedResponse listIntents(String parent) {
ListIntentsRequest request = ListIntentsRequest.newBuilder().setParent(parent).build();
return listIntents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* String languageCode = "";
* for (Intent element : intentsClient.listIntents(parent, languageCode).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The agent to list all intents from. Format: `projects/<Project
* ID>/agent`.
* @param languageCode Optional. The language to list training phrases, parameters and rich
* messages for. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListIntentsPagedResponse listIntents(ProjectAgentName parent, String languageCode) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setLanguageCode(languageCode)
.build();
return listIntents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* String languageCode = "";
* for (Intent element : intentsClient.listIntents(parent.toString(), languageCode).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The agent to list all intents from. Format: `projects/<Project
* ID>/agent`.
* @param languageCode Optional. The language to list training phrases, parameters and rich
* messages for. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListIntentsPagedResponse listIntents(String parent, String languageCode) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder().setParent(parent).setLanguageCode(languageCode).build();
return listIntents(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* ListIntentsRequest request = ListIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* for (Intent element : intentsClient.listIntents(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 ListIntentsPagedResponse listIntents(ListIntentsRequest request) {
return listIntentsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* ListIntentsRequest request = ListIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* ApiFuture<ListIntentsPagedResponse> future = intentsClient.listIntentsPagedCallable().futureCall(request);
* // Do something
* for (Intent element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*/
public final UnaryCallable
listIntentsPagedCallable() {
return stub.listIntentsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all intents in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* ListIntentsRequest request = ListIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* while (true) {
* ListIntentsResponse response = intentsClient.listIntentsCallable().call(request);
* for (Intent element : response.getIntentsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
*
*/
public final UnaryCallable listIntentsCallable() {
return stub.listIntentsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* Intent response = intentsClient.getIntent(name);
* }
*
*
* @param name Required. The name of the intent. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent getIntent(IntentName name) {
GetIntentRequest request =
GetIntentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* Intent response = intentsClient.getIntent(name.toString());
* }
*
*
* @param name Required. The name of the intent. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent getIntent(String name) {
GetIntentRequest request = GetIntentRequest.newBuilder().setName(name).build();
return getIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* String languageCode = "";
* Intent response = intentsClient.getIntent(name, languageCode);
* }
*
*
* @param name Required. The name of the intent. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @param languageCode Optional. The language to retrieve training phrases, parameters and rich
* messages for. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent getIntent(IntentName name, String languageCode) {
GetIntentRequest request =
GetIntentRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setLanguageCode(languageCode)
.build();
return getIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* String languageCode = "";
* Intent response = intentsClient.getIntent(name.toString(), languageCode);
* }
*
*
* @param name Required. The name of the intent. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @param languageCode Optional. The language to retrieve training phrases, parameters and rich
* messages for. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent getIntent(String name, String languageCode) {
GetIntentRequest request =
GetIntentRequest.newBuilder().setName(name).setLanguageCode(languageCode).build();
return getIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* GetIntentRequest request = GetIntentRequest.newBuilder()
* .setName(name.toString())
* .build();
* Intent response = intentsClient.getIntent(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 Intent getIntent(GetIntentRequest request) {
return getIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* GetIntentRequest request = GetIntentRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<Intent> future = intentsClient.getIntentCallable().futureCall(request);
* // Do something
* Intent response = future.get();
* }
*
*/
public final UnaryCallable getIntentCallable() {
return stub.getIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* Intent response = intentsClient.createIntent(parent, intent);
* }
*
*
* @param parent Required. The agent to create a intent for. Format: `projects/<Project
* ID>/agent`.
* @param intent Required. The intent to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent createIntent(ProjectAgentName parent, Intent intent) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setIntent(intent)
.build();
return createIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* Intent response = intentsClient.createIntent(parent.toString(), intent);
* }
*
*
* @param parent Required. The agent to create a intent for. Format: `projects/<Project
* ID>/agent`.
* @param intent Required. The intent to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent createIntent(String parent, Intent intent) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder().setParent(parent).setIntent(intent).build();
return createIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* Intent response = intentsClient.createIntent(parent, intent, languageCode);
* }
*
*
* @param parent Required. The agent to create a intent for. Format: `projects/<Project
* ID>/agent`.
* @param intent Required. The intent to create.
* @param languageCode Optional. The language of training phrases, parameters and rich messages
* defined in `intent`. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent createIntent(ProjectAgentName parent, Intent intent, String languageCode) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setIntent(intent)
.setLanguageCode(languageCode)
.build();
return createIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* Intent response = intentsClient.createIntent(parent.toString(), intent, languageCode);
* }
*
*
* @param parent Required. The agent to create a intent for. Format: `projects/<Project
* ID>/agent`.
* @param intent Required. The intent to create.
* @param languageCode Optional. The language of training phrases, parameters and rich messages
* defined in `intent`. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent createIntent(String parent, Intent intent, String languageCode) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder()
.setParent(parent)
.setIntent(intent)
.setLanguageCode(languageCode)
.build();
return createIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* CreateIntentRequest request = CreateIntentRequest.newBuilder()
* .setParent(parent.toString())
* .setIntent(intent)
* .build();
* Intent response = intentsClient.createIntent(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 Intent createIntent(CreateIntentRequest request) {
return createIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates an intent in the specified agent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* Intent intent = Intent.newBuilder().build();
* CreateIntentRequest request = CreateIntentRequest.newBuilder()
* .setParent(parent.toString())
* .setIntent(intent)
* .build();
* ApiFuture<Intent> future = intentsClient.createIntentCallable().futureCall(request);
* // Do something
* Intent response = future.get();
* }
*
*/
public final UnaryCallable createIntentCallable() {
return stub.createIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* Intent response = intentsClient.updateIntent(intent, languageCode);
* }
*
*
* @param intent Required. The intent to update.
* @param languageCode Optional. The language of training phrases, parameters and rich messages
* defined in `intent`. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent updateIntent(Intent intent, String languageCode) {
UpdateIntentRequest request =
UpdateIntentRequest.newBuilder().setIntent(intent).setLanguageCode(languageCode).build();
return updateIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* FieldMask updateMask = FieldMask.newBuilder().build();
* Intent response = intentsClient.updateIntent(intent, languageCode, updateMask);
* }
*
*
* @param intent Required. The intent to update.
* @param languageCode Optional. The language of training phrases, parameters and rich messages
* defined in `intent`. If not specified, the agent's default language is used. [Many
* languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are
* supported. Note: languages must be enabled in the agent before they can be used.
* @param updateMask Optional. The mask to control which fields get updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Intent updateIntent(Intent intent, String languageCode, FieldMask updateMask) {
UpdateIntentRequest request =
UpdateIntentRequest.newBuilder()
.setIntent(intent)
.setLanguageCode(languageCode)
.setUpdateMask(updateMask)
.build();
return updateIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* UpdateIntentRequest request = UpdateIntentRequest.newBuilder()
* .setIntent(intent)
* .setLanguageCode(languageCode)
* .build();
* Intent response = intentsClient.updateIntent(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 Intent updateIntent(UpdateIntentRequest request) {
return updateIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified intent.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* Intent intent = Intent.newBuilder().build();
* String languageCode = "";
* UpdateIntentRequest request = UpdateIntentRequest.newBuilder()
* .setIntent(intent)
* .setLanguageCode(languageCode)
* .build();
* ApiFuture<Intent> future = intentsClient.updateIntentCallable().futureCall(request);
* // Do something
* Intent response = future.get();
* }
*
*/
public final UnaryCallable updateIntentCallable() {
return stub.updateIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified intent and its direct or indirect followup intents.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* intentsClient.deleteIntent(name);
* }
*
*
* @param name Required. The name of the intent to delete. If this intent has direct or indirect
* followup intents, we also delete them. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteIntent(IntentName name) {
DeleteIntentRequest request =
DeleteIntentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified intent and its direct or indirect followup intents.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* intentsClient.deleteIntent(name.toString());
* }
*
*
* @param name Required. The name of the intent to delete. If this intent has direct or indirect
* followup intents, we also delete them. Format: `projects/<Project
* ID>/agent/intents/<Intent ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteIntent(String name) {
DeleteIntentRequest request = DeleteIntentRequest.newBuilder().setName(name).build();
deleteIntent(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified intent and its direct or indirect followup intents.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* DeleteIntentRequest request = DeleteIntentRequest.newBuilder()
* .setName(name.toString())
* .build();
* intentsClient.deleteIntent(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 deleteIntent(DeleteIntentRequest request) {
deleteIntentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified intent and its direct or indirect followup intents.
*
* Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
* DeleteIntentRequest request = DeleteIntentRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<Void> future = intentsClient.deleteIntentCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
public final UnaryCallable deleteIntentCallable() {
return stub.deleteIntentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates/Creates multiple intents in the specified agent.
*
* Operation <response:
* [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* String languageCode = "";
* BatchUpdateIntentsRequest request = BatchUpdateIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .setLanguageCode(languageCode)
* .build();
* BatchUpdateIntentsResponse response = intentsClient.batchUpdateIntentsAsync(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
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture batchUpdateIntentsAsync(
BatchUpdateIntentsRequest request) {
return batchUpdateIntentsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates/Creates multiple intents in the specified agent.
*
* Operation <response:
* [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* String languageCode = "";
* BatchUpdateIntentsRequest request = BatchUpdateIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .setLanguageCode(languageCode)
* .build();
* OperationFuture<BatchUpdateIntentsResponse, Struct> future = intentsClient.batchUpdateIntentsOperationCallable().futureCall(request);
* // Do something
* BatchUpdateIntentsResponse response = future.get();
* }
*
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable
batchUpdateIntentsOperationCallable() {
return stub.batchUpdateIntentsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates/Creates multiple intents in the specified agent.
*
* Operation <response:
* [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* String languageCode = "";
* BatchUpdateIntentsRequest request = BatchUpdateIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .setLanguageCode(languageCode)
* .build();
* ApiFuture<Operation> future = intentsClient.batchUpdateIntentsCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
*
*/
public final UnaryCallable batchUpdateIntentsCallable() {
return stub.batchUpdateIntentsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes intents in the specified agent.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* List<Intent> intents = new ArrayList<>();
* intentsClient.batchDeleteIntentsAsync(parent, intents).get();
* }
*
*
* @param parent Required. The name of the agent to delete all entities types for. Format:
* `projects/<Project ID>/agent`.
* @param intents Required. The collection of intents to delete. Only intent `name` must be filled
* in.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture batchDeleteIntentsAsync(
ProjectAgentName parent, List intents) {
BatchDeleteIntentsRequest request =
BatchDeleteIntentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.addAllIntents(intents)
.build();
return batchDeleteIntentsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes intents in the specified agent.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* List<Intent> intents = new ArrayList<>();
* intentsClient.batchDeleteIntentsAsync(parent.toString(), intents).get();
* }
*
*
* @param parent Required. The name of the agent to delete all entities types for. Format:
* `projects/<Project ID>/agent`.
* @param intents Required. The collection of intents to delete. Only intent `name` must be filled
* in.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture batchDeleteIntentsAsync(
String parent, List intents) {
BatchDeleteIntentsRequest request =
BatchDeleteIntentsRequest.newBuilder().setParent(parent).addAllIntents(intents).build();
return batchDeleteIntentsAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes intents in the specified agent.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* List<Intent> intents = new ArrayList<>();
* BatchDeleteIntentsRequest request = BatchDeleteIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .addAllIntents(intents)
* .build();
* intentsClient.batchDeleteIntentsAsync(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
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture batchDeleteIntentsAsync(
BatchDeleteIntentsRequest request) {
return batchDeleteIntentsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes intents in the specified agent.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* List<Intent> intents = new ArrayList<>();
* BatchDeleteIntentsRequest request = BatchDeleteIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .addAllIntents(intents)
* .build();
* OperationFuture<Empty, Struct> future = intentsClient.batchDeleteIntentsOperationCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable
batchDeleteIntentsOperationCallable() {
return stub.batchDeleteIntentsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes intents in the specified agent.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
*
*
Sample code:
*
*
* try (IntentsClient intentsClient = IntentsClient.create()) {
* ProjectAgentName parent = ProjectAgentName.of("[PROJECT]");
* List<Intent> intents = new ArrayList<>();
* BatchDeleteIntentsRequest request = BatchDeleteIntentsRequest.newBuilder()
* .setParent(parent.toString())
* .addAllIntents(intents)
* .build();
* ApiFuture<Operation> future = intentsClient.batchDeleteIntentsCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
public final UnaryCallable batchDeleteIntentsCallable() {
return stub.batchDeleteIntentsCallable();
}
@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 ListIntentsPagedResponse
extends AbstractPagedListResponse<
ListIntentsRequest,
ListIntentsResponse,
Intent,
ListIntentsPage,
ListIntentsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListIntentsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListIntentsPagedResponse apply(ListIntentsPage input) {
return new ListIntentsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListIntentsPagedResponse(ListIntentsPage page) {
super(page, ListIntentsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListIntentsPage
extends AbstractPage {
private ListIntentsPage(
PageContext context,
ListIntentsResponse response) {
super(context, response);
}
private static ListIntentsPage createEmptyPage() {
return new ListIntentsPage(null, null);
}
@Override
protected ListIntentsPage createPage(
PageContext context,
ListIntentsResponse response) {
return new ListIntentsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListIntentsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListIntentsRequest,
ListIntentsResponse,
Intent,
ListIntentsPage,
ListIntentsFixedSizeCollection> {
private ListIntentsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListIntentsFixedSizeCollection createEmptyCollection() {
return new ListIntentsFixedSizeCollection(null, 0);
}
@Override
protected ListIntentsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListIntentsFixedSizeCollection(pages, collectionSize);
}
}
}