com.google.cloud.dialogflow.v2

Class IntentsClient

java.lang.Object

com.google.cloud.dialogflow.v2.IntentsClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class IntentsClient
extends Object
implements BackgroundResource

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:

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of 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);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntentsClient.ListIntentsFixedSizeCollection
static class	IntentsClient.ListIntentsPage
static class	IntentsClient.ListIntentsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntentsClient(IntentsSettings settings) Constructs an instance of IntentsClient, using the given settings.
protected	IntentsClient(IntentsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
OperationFuture<Empty,Struct>	batchDeleteIntentsAsync(com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest request) Deletes intents in the specified agent.
OperationFuture<Empty,Struct>	batchDeleteIntentsAsync(com.google.cloud.dialogflow.v2.ProjectAgentName parent, List<com.google.cloud.dialogflow.v2.Intent> intents) Deletes intents in the specified agent.
OperationFuture<Empty,Struct>	batchDeleteIntentsAsync(String parent, List<com.google.cloud.dialogflow.v2.Intent> intents) Deletes intents in the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest,Operation>	batchDeleteIntentsCallable() Deletes intents in the specified agent.
OperationCallable<com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest,Empty,Struct>	batchDeleteIntentsOperationCallable() Deletes intents in the specified agent.
OperationFuture<com.google.cloud.dialogflow.v2.BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest request) Updates/Creates multiple intents in the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest,Operation>	batchUpdateIntentsCallable() Updates/Creates multiple intents in the specified agent.
OperationCallable<com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest,com.google.cloud.dialogflow.v2.BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsOperationCallable() Updates/Creates multiple intents in the specified agent.
void	close()
static IntentsClient	create() Constructs an instance of IntentsClient with default settings.
static IntentsClient	create(IntentsSettings settings) Constructs an instance of IntentsClient, using the given settings.
static IntentsClient	create(IntentsStub stub) Constructs an instance of IntentsClient, using the given stub for making calls.
com.google.cloud.dialogflow.v2.Intent	createIntent(com.google.cloud.dialogflow.v2.CreateIntentRequest request) Creates an intent in the specified agent.
com.google.cloud.dialogflow.v2.Intent	createIntent(com.google.cloud.dialogflow.v2.ProjectAgentName parent, com.google.cloud.dialogflow.v2.Intent intent) Creates an intent in the specified agent.
com.google.cloud.dialogflow.v2.Intent	createIntent(com.google.cloud.dialogflow.v2.ProjectAgentName parent, com.google.cloud.dialogflow.v2.Intent intent, String languageCode) Creates an intent in the specified agent.
com.google.cloud.dialogflow.v2.Intent	createIntent(String parent, com.google.cloud.dialogflow.v2.Intent intent) Creates an intent in the specified agent.
com.google.cloud.dialogflow.v2.Intent	createIntent(String parent, com.google.cloud.dialogflow.v2.Intent intent, String languageCode) Creates an intent in the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2.CreateIntentRequest,com.google.cloud.dialogflow.v2.Intent>	createIntentCallable() Creates an intent in the specified agent.
void	deleteIntent(com.google.cloud.dialogflow.v2.DeleteIntentRequest request) Deletes the specified intent and its direct or indirect followup intents.
void	deleteIntent(com.google.cloud.dialogflow.v2.IntentName name) Deletes the specified intent and its direct or indirect followup intents.
void	deleteIntent(String name) Deletes the specified intent and its direct or indirect followup intents.
UnaryCallable<com.google.cloud.dialogflow.v2.DeleteIntentRequest,Empty>	deleteIntentCallable() Deletes the specified intent and its direct or indirect followup intents.
com.google.cloud.dialogflow.v2.Intent	getIntent(com.google.cloud.dialogflow.v2.GetIntentRequest request) Retrieves the specified intent.
com.google.cloud.dialogflow.v2.Intent	getIntent(com.google.cloud.dialogflow.v2.IntentName name) Retrieves the specified intent.
com.google.cloud.dialogflow.v2.Intent	getIntent(com.google.cloud.dialogflow.v2.IntentName name, String languageCode) Retrieves the specified intent.
com.google.cloud.dialogflow.v2.Intent	getIntent(String name) Retrieves the specified intent.
com.google.cloud.dialogflow.v2.Intent	getIntent(String name, String languageCode) Retrieves the specified intent.
UnaryCallable<com.google.cloud.dialogflow.v2.GetIntentRequest,com.google.cloud.dialogflow.v2.Intent>	getIntentCallable() Retrieves the specified intent.
OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
IntentsSettings	getSettings()
IntentsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
IntentsClient.ListIntentsPagedResponse	listIntents(com.google.cloud.dialogflow.v2.ListIntentsRequest request) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(com.google.cloud.dialogflow.v2.ProjectAgentName parent) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(com.google.cloud.dialogflow.v2.ProjectAgentName parent, String languageCode) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(String parent) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(String parent, String languageCode) Returns the list of all intents in the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2.ListIntentsRequest,com.google.cloud.dialogflow.v2.ListIntentsResponse>	listIntentsCallable() Returns the list of all intents in the specified agent.
UnaryCallable<com.google.cloud.dialogflow.v2.ListIntentsRequest,IntentsClient.ListIntentsPagedResponse>	listIntentsPagedCallable() Returns the list of all intents in the specified agent.
void	shutdown()
void	shutdownNow()
com.google.cloud.dialogflow.v2.Intent	updateIntent(com.google.cloud.dialogflow.v2.Intent intent, String languageCode) Updates the specified intent.
com.google.cloud.dialogflow.v2.Intent	updateIntent(com.google.cloud.dialogflow.v2.Intent intent, String languageCode, FieldMask updateMask) Updates the specified intent.
com.google.cloud.dialogflow.v2.Intent	updateIntent(com.google.cloud.dialogflow.v2.UpdateIntentRequest request) Updates the specified intent.
UnaryCallable<com.google.cloud.dialogflow.v2.UpdateIntentRequest,com.google.cloud.dialogflow.v2.Intent>	updateIntentCallable() Updates the specified intent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntentsClient

protected IntentsClient(IntentsSettings settings)
                 throws IOException

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.

Throws:

IOException

IntentsClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected IntentsClient(IntentsStub stub)

Method Detail

create

public static final IntentsClient create()
                                  throws IOException

Constructs an instance of IntentsClient with default settings.

Throws:

IOException

create

public static final IntentsClient create(IntentsSettings settings)
                                  throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final IntentsClient create(IntentsStub stub)

Constructs an instance of IntentsClient, using the given stub for making calls. This is for advanced usage - prefer to use IntentsSettings}.

getSettings

public final IntentsSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public IntentsStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(com.google.cloud.dialogflow.v2.ProjectAgentName parent)

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);
   }
 }
 

Parameters:

parent - Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.

Throws:

ApiException - if the remote call fails

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(String parent)

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);
   }
 }
 

Parameters:

parent - Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.

Throws:

ApiException - if the remote call fails

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(com.google.cloud.dialogflow.v2.ProjectAgentName parent,
                                                                String languageCode)

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);
   }
 }
 

Parameters:

parent - Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.

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:

ApiException - if the remote call fails

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(String parent,
                                                                String languageCode)

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);
   }
 }
 

Parameters:

parent - Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.

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:

ApiException - if the remote call fails

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(com.google.cloud.dialogflow.v2.ListIntentsRequest request)

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);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

listIntentsPagedCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.ListIntentsRequest,IntentsClient.ListIntentsPagedResponse> listIntentsPagedCallable()

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);
   }
 }
 

listIntentsCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.ListIntentsRequest,com.google.cloud.dialogflow.v2.ListIntentsResponse> listIntentsCallable()

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;
     }
   }
 }
 

getIntent

public final com.google.cloud.dialogflow.v2.Intent getIntent(com.google.cloud.dialogflow.v2.IntentName name)

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
   Intent response = intentsClient.getIntent(name);
 }
 

Parameters:

name - Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Throws:

ApiException - if the remote call fails

getIntent

public final com.google.cloud.dialogflow.v2.Intent getIntent(String name)

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.of("[PROJECT]", "[INTENT]");
   Intent response = intentsClient.getIntent(name.toString());
 }
 

Parameters:

name - Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Throws:

ApiException - if the remote call fails

getIntent

public final com.google.cloud.dialogflow.v2.Intent getIntent(com.google.cloud.dialogflow.v2.IntentName name,
                                                             String languageCode)

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);
 }
 

Parameters:

name - Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

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:

ApiException - if the remote call fails

getIntent

public final com.google.cloud.dialogflow.v2.Intent getIntent(String name,
                                                             String languageCode)

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);
 }
 

Parameters:

name - Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

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:

ApiException - if the remote call fails

getIntent

public final com.google.cloud.dialogflow.v2.Intent getIntent(com.google.cloud.dialogflow.v2.GetIntentRequest request)

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);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getIntentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.GetIntentRequest,com.google.cloud.dialogflow.v2.Intent> getIntentCallable()

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();
 }
 

createIntent

public final com.google.cloud.dialogflow.v2.Intent createIntent(com.google.cloud.dialogflow.v2.ProjectAgentName parent,
                                                                com.google.cloud.dialogflow.v2.Intent intent)

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);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.

intent - Required. The intent to create.

Throws:

ApiException - if the remote call fails

createIntent

public final com.google.cloud.dialogflow.v2.Intent createIntent(String parent,
                                                                com.google.cloud.dialogflow.v2.Intent intent)

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);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.

intent - Required. The intent to create.

Throws:

ApiException - if the remote call fails

createIntent

public final com.google.cloud.dialogflow.v2.Intent createIntent(com.google.cloud.dialogflow.v2.ProjectAgentName parent,
                                                                com.google.cloud.dialogflow.v2.Intent intent,
                                                                String languageCode)

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);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.

intent - Required. The intent to create.

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:

ApiException - if the remote call fails

createIntent

public final com.google.cloud.dialogflow.v2.Intent createIntent(String parent,
                                                                com.google.cloud.dialogflow.v2.Intent intent,
                                                                String languageCode)

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);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.

intent - Required. The intent to create.

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:

ApiException - if the remote call fails

createIntent

public final com.google.cloud.dialogflow.v2.Intent createIntent(com.google.cloud.dialogflow.v2.CreateIntentRequest request)

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);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

createIntentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.CreateIntentRequest,com.google.cloud.dialogflow.v2.Intent> createIntentCallable()

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();
 }
 

updateIntent

public final com.google.cloud.dialogflow.v2.Intent updateIntent(com.google.cloud.dialogflow.v2.Intent intent,
                                                                String languageCode)

Updates the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   Intent intent = Intent.newBuilder().build();
   String languageCode = "";
   Intent response = intentsClient.updateIntent(intent, languageCode);
 }
 

Parameters:

intent - Required. The intent to update.

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:

ApiException - if the remote call fails

updateIntent

public final com.google.cloud.dialogflow.v2.Intent updateIntent(com.google.cloud.dialogflow.v2.Intent intent,
                                                                String languageCode,
                                                                FieldMask updateMask)

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);
 }
 

Parameters:

intent - Required. The intent to update.

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.

updateMask - Optional. The mask to control which fields get updated.

Throws:

ApiException - if the remote call fails

updateIntent

public final com.google.cloud.dialogflow.v2.Intent updateIntent(com.google.cloud.dialogflow.v2.UpdateIntentRequest request)

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);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

updateIntentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.UpdateIntentRequest,com.google.cloud.dialogflow.v2.Intent> updateIntentCallable()

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();
 }
 

deleteIntent

public final void deleteIntent(com.google.cloud.dialogflow.v2.IntentName name)

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);
 }
 

Parameters:

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:

ApiException - if the remote call fails

deleteIntent

public final void deleteIntent(String name)

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());
 }
 

Parameters:

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:

ApiException - if the remote call fails

deleteIntent

public final void deleteIntent(com.google.cloud.dialogflow.v2.DeleteIntentRequest request)

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);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

deleteIntentCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.DeleteIntentRequest,Empty> deleteIntentCallable()

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();
 }
 

batchUpdateIntentsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dialogflow.v2.BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest request)

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();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

batchUpdateIntentsOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest,com.google.cloud.dialogflow.v2.BatchUpdateIntentsResponse,Struct> batchUpdateIntentsOperationCallable()

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();
 }
 

batchUpdateIntentsCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.BatchUpdateIntentsRequest,Operation> batchUpdateIntentsCallable()

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();
 }
 

batchDeleteIntentsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(com.google.cloud.dialogflow.v2.ProjectAgentName parent,
                                                                                                                                                                             List<com.google.cloud.dialogflow.v2.Intent> intents)

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();
 }
 

Parameters:

parent - Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.

intents - Required. The collection of intents to delete. Only intent `name` must be filled in.

Throws:

ApiException - if the remote call fails

batchDeleteIntentsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(String parent,
                                                                                                                                                                             List<com.google.cloud.dialogflow.v2.Intent> intents)

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();
 }
 

Parameters:

parent - Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.

intents - Required. The collection of intents to delete. Only intent `name` must be filled in.

Throws:

ApiException - if the remote call fails

batchDeleteIntentsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest request)

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();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

batchDeleteIntentsOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest,Empty,Struct> batchDeleteIntentsOperationCallable()

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();
 }
 

batchDeleteIntentsCallable

public final UnaryCallable<com.google.cloud.dialogflow.v2.BatchDeleteIntentsRequest,Operation> batchDeleteIntentsCallable()

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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException