com.google.cloud.dialogflow.v2beta1

Class IntentsClient

java.lang.Object

com.google.cloud.dialogflow.v2beta1.IntentsClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

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

Service Description: Service for managing [Intents][google.cloud.dialogflow.v2beta1.Intent].

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.ofProjectIntentName("[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);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

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(AgentName parent, List<Intent> intents) Deletes intents in the specified agent.
OperationFuture<Empty,Struct>	batchDeleteIntentsAsync(BatchDeleteIntentsRequest request) Deletes intents in the specified agent.
OperationFuture<Empty,Struct>	batchDeleteIntentsAsync(String parent, List<Intent> intents) Deletes intents in the specified agent.
UnaryCallable<BatchDeleteIntentsRequest,Operation>	batchDeleteIntentsCallable() Deletes intents in the specified agent.
OperationCallable<BatchDeleteIntentsRequest,Empty,Struct>	batchDeleteIntentsOperationCallable() Deletes intents in the specified agent.
OperationFuture<BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(AgentName parent, IntentBatch intentBatchInline) Updates/Creates multiple intents in the specified agent.
OperationFuture<BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(AgentName parent, String intentBatchUri) Updates/Creates multiple intents in the specified agent.
OperationFuture<BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(BatchUpdateIntentsRequest request) Updates/Creates multiple intents in the specified agent.
OperationFuture<BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(String parent, IntentBatch intentBatchInline) Updates/Creates multiple intents in the specified agent.
OperationFuture<BatchUpdateIntentsResponse,Struct>	batchUpdateIntentsAsync(String parent, String intentBatchUri) Updates/Creates multiple intents in the specified agent.
UnaryCallable<BatchUpdateIntentsRequest,Operation>	batchUpdateIntentsCallable() Updates/Creates multiple intents in the specified agent.
OperationCallable<BatchUpdateIntentsRequest,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.
Intent	createIntent(AgentName parent, Intent intent) Creates an intent in the specified agent.
Intent	createIntent(AgentName parent, Intent intent, String languageCode) Creates an intent in the specified agent.
Intent	createIntent(CreateIntentRequest request) Creates an intent in the specified agent.
Intent	createIntent(String parent, Intent intent) Creates an intent in the specified agent.
Intent	createIntent(String parent, Intent intent, String languageCode) Creates an intent in the specified agent.
UnaryCallable<CreateIntentRequest,Intent>	createIntentCallable() Creates an intent in the specified agent.
void	deleteIntent(DeleteIntentRequest request) Deletes the specified intent and its direct or indirect followup intents.
void	deleteIntent(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<DeleteIntentRequest,Empty>	deleteIntentCallable() Deletes the specified intent and its direct or indirect followup intents.
Intent	getIntent(GetIntentRequest request) Retrieves the specified intent.
Intent	getIntent(IntentName name) Retrieves the specified intent.
Intent	getIntent(IntentName name, String languageCode) Retrieves the specified intent.
Intent	getIntent(String name) Retrieves the specified intent.
Intent	getIntent(String name, String languageCode) Retrieves the specified intent.
UnaryCallable<GetIntentRequest,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(AgentName parent) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(AgentName parent, String languageCode) Returns the list of all intents in the specified agent.
IntentsClient.ListIntentsPagedResponse	listIntents(ListIntentsRequest request) 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<ListIntentsRequest,ListIntentsResponse>	listIntentsCallable() Returns the list of all intents in the specified agent.
UnaryCallable<ListIntentsRequest,IntentsClient.ListIntentsPagedResponse>	listIntentsPagedCallable() Returns the list of all intents in the specified agent.
void	shutdown()
void	shutdownNow()
Intent	updateIntent(Intent intent) Updates the specified intent.
Intent	updateIntent(Intent intent, FieldMask updateMask) Updates the specified intent.
Intent	updateIntent(Intent intent, String languageCode) Updates the specified intent.
Intent	updateIntent(Intent intent, String languageCode, FieldMask updateMask) Updates the specified intent.
Intent	updateIntent(UpdateIntentRequest request) Updates the specified intent.
UnaryCallable<UpdateIntentRequest,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 using create(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

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(AgentName parent)

Returns the list of all intents in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[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` or `projects/<Project ID>/locations/<Location ID>/agent`.

Alternatively, you can specify the environment to list intents for. Format: `projects/<Project ID>/agent/environments/<Environment ID>` or `projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>`. Note: training phrases of the intents will not be returned for non-draft environment.

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()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Alternatively, you can specify the environment to list intents for. Format: `projects/<Project ID>/agent/environments/<Environment ID>` or `projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>`. Note: training phrases of the intents will not be returned for non-draft environment.

Throws:

ApiException - if the remote call fails

listIntents

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

Returns the list of all intents in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   String languageCode = "languageCode-2092349083";
   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` or `projects/<Project ID>/locations/<Location ID>/agent`.

Alternatively, you can specify the environment to list intents for. Format: `projects/<Project ID>/agent/environments/<Environment ID>` or `projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>`. Note: training phrases of the intents will not be returned for non-draft environment.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

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()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   String languageCode = "languageCode-2092349083";
   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` or `projects/<Project ID>/locations/<Location ID>/agent`.

Alternatively, you can specify the environment to list intents for. Format: `projects/<Project ID>/agent/environments/<Environment ID>` or `projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>`. Note: training phrases of the intents will not be returned for non-draft environment.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

listIntents

public final IntentsClient.ListIntentsPagedResponse listIntents(ListIntentsRequest request)

Returns the list of all intents in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   ListIntentsRequest request =
       ListIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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<ListIntentsRequest,IntentsClient.ListIntentsPagedResponse> listIntentsPagedCallable()

Returns the list of all intents in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   ListIntentsRequest request =
       ListIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Intent> future = intentsClient.listIntentsPagedCallable().futureCall(request);
   // Do something.
   for (Intent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listIntentsCallable

public final UnaryCallable<ListIntentsRequest,ListIntentsResponse> listIntentsCallable()

Returns the list of all intents in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   ListIntentsRequest request =
       ListIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListIntentsResponse response = intentsClient.listIntentsCallable().call(request);
     for (Intent element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getIntent

public final Intent getIntent(IntentName name)

Retrieves the specified intent.

Sample code:

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

Parameters:

name - Required. The name of the intent. Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`

Throws:

ApiException - if the remote call fails

getIntent

public final Intent getIntent(String name)

Retrieves the specified intent.

Sample code:

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

Parameters:

name - Required. The name of the intent. Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`

Throws:

ApiException - if the remote call fails

getIntent

public final Intent getIntent(IntentName name,
                              String languageCode)

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]");
   String languageCode = "languageCode-2092349083";
   Intent response = intentsClient.getIntent(name, languageCode);
 }
 

Parameters:

name - Required. The name of the intent. Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

getIntent

public final Intent getIntent(String name,
                              String languageCode)

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String name = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   String languageCode = "languageCode-2092349083";
   Intent response = intentsClient.getIntent(name, languageCode);
 }
 

Parameters:

name - Required. The name of the intent. Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

getIntent

public final Intent getIntent(GetIntentRequest request)

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   GetIntentRequest request =
       GetIntentRequest.newBuilder()
           .setName(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .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<GetIntentRequest,Intent> getIntentCallable()

Retrieves the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   GetIntentRequest request =
       GetIntentRequest.newBuilder()
           .setName(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .build();
   ApiFuture<Intent> future = intentsClient.getIntentCallable().futureCall(request);
   // Do something.
   Intent response = future.get();
 }
 

createIntent

public final Intent createIntent(AgentName parent,
                                 Intent intent)

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   Intent intent = Intent.newBuilder().build();
   Intent response = intentsClient.createIntent(parent, intent);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intent - Required. The intent to create.

Throws:

ApiException - if the remote call fails

createIntent

public final Intent createIntent(String parent,
                                 Intent intent)

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   Intent intent = Intent.newBuilder().build();
   Intent response = intentsClient.createIntent(parent, intent);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intent - Required. The intent to create.

Throws:

ApiException - if the remote call fails

createIntent

public final Intent createIntent(AgentName parent,
                                 Intent intent,
                                 String languageCode)

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   Intent intent = Intent.newBuilder().build();
   String languageCode = "languageCode-2092349083";
   Intent response = intentsClient.createIntent(parent, intent, languageCode);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intent - Required. The intent to create.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

createIntent

public final Intent createIntent(String parent,
                                 Intent intent,
                                 String languageCode)

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   Intent intent = Intent.newBuilder().build();
   String languageCode = "languageCode-2092349083";
   Intent response = intentsClient.createIntent(parent, intent, languageCode);
 }
 

Parameters:

parent - Required. The agent to create a intent for. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intent - Required. The intent to create.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

createIntent

public final Intent createIntent(CreateIntentRequest request)

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   CreateIntentRequest request =
       CreateIntentRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setIntent(Intent.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .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<CreateIntentRequest,Intent> createIntentCallable()

Creates an intent in the specified agent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   CreateIntentRequest request =
       CreateIntentRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setIntent(Intent.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setIntentView(IntentView.forNumber(0))
           .build();
   ApiFuture<Intent> future = intentsClient.createIntentCallable().futureCall(request);
   // Do something.
   Intent response = future.get();
 }
 

updateIntent

public final Intent updateIntent(Intent intent)

Updates the specified intent.

Sample code:

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

Parameters:

intent - Required. The intent to update.

Throws:

ApiException - if the remote call fails

updateIntent

public final Intent updateIntent(Intent intent,
                                 FieldMask updateMask)

Updates the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   Intent intent = Intent.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Intent response = intentsClient.updateIntent(intent, updateMask);
 }
 

Parameters:

intent - Required. The intent to update.

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

Throws:

ApiException - if the remote call fails

updateIntent

public final Intent updateIntent(Intent intent,
                                 String languageCode)

Updates the specified intent.

Sample code:

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

Parameters:

intent - Required. The intent to update.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

updateIntent

public final Intent updateIntent(Intent intent,
                                 String languageCode,
                                 FieldMask updateMask)

Updates the specified intent.

Sample code:

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

Parameters:

intent - Required. The intent to update.

languageCode - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

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

Throws:

ApiException - if the remote call fails

updateIntent

public final Intent updateIntent(UpdateIntentRequest request)

Updates the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   UpdateIntentRequest request =
       UpdateIntentRequest.newBuilder()
           .setIntent(Intent.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIntentView(IntentView.forNumber(0))
           .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<UpdateIntentRequest,Intent> updateIntentCallable()

Updates the specified intent.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   UpdateIntentRequest request =
       UpdateIntentRequest.newBuilder()
           .setIntent(Intent.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIntentView(IntentView.forNumber(0))
           .build();
   ApiFuture<Intent> future = intentsClient.updateIntentCallable().futureCall(request);
   // Do something.
   Intent response = future.get();
 }
 

deleteIntent

public final void deleteIntent(IntentName name)

Deletes the specified intent and its direct or indirect followup intents.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.ofProjectIntentName("[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.

Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location 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()) {
   String name = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   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.

Supported formats:

- `projects/<Project ID>/agent/intents/<Intent ID>` - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`

Throws:

ApiException - if the remote call fails

deleteIntent

public final void deleteIntent(DeleteIntentRequest request)

Deletes the specified intent and its direct or indirect followup intents.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   DeleteIntentRequest request =
       DeleteIntentRequest.newBuilder()
           .setName(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").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<DeleteIntentRequest,Empty> deleteIntentCallable()

Deletes the specified intent and its direct or indirect followup intents.

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   DeleteIntentRequest request =
       DeleteIntentRequest.newBuilder()
           .setName(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .build();
   ApiFuture<Empty> future = intentsClient.deleteIntentCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

batchUpdateIntentsAsync

public final OperationFuture<BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(AgentName parent,
                                                                                        IntentBatch intentBatchInline)

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   IntentBatch intentBatchInline = IntentBatch.newBuilder().build();
   BatchUpdateIntentsResponse response =
       intentsClient.batchUpdateIntentsAsync(parent, intentBatchInline).get();
 }
 

Parameters:

parent - Required. The name of the agent to update or create intents in. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intentBatchInline - The collection of intents to update or create.

Throws:

ApiException - if the remote call fails

batchUpdateIntentsAsync

public final OperationFuture<BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(AgentName parent,
                                                                                        String intentBatchUri)

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   String intentBatchUri = "intentBatchUri544125582";
   BatchUpdateIntentsResponse response =
       intentsClient.batchUpdateIntentsAsync(parent, intentBatchUri).get();
 }
 

Parameters:

parent - Required. The name of the agent to update or create intents in. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intentBatchUri - The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

Throws:

ApiException - if the remote call fails

batchUpdateIntentsAsync

public final OperationFuture<BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(String parent,
                                                                                        IntentBatch intentBatchInline)

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   IntentBatch intentBatchInline = IntentBatch.newBuilder().build();
   BatchUpdateIntentsResponse response =
       intentsClient.batchUpdateIntentsAsync(parent, intentBatchInline).get();
 }
 

Parameters:

parent - Required. The name of the agent to update or create intents in. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intentBatchInline - The collection of intents to update or create.

Throws:

ApiException - if the remote call fails

batchUpdateIntentsAsync

public final OperationFuture<BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(String parent,
                                                                                        String intentBatchUri)

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   String intentBatchUri = "intentBatchUri544125582";
   BatchUpdateIntentsResponse response =
       intentsClient.batchUpdateIntentsAsync(parent, intentBatchUri).get();
 }
 

Parameters:

parent - Required. The name of the agent to update or create intents in. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent`

intentBatchUri - The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

Throws:

ApiException - if the remote call fails

batchUpdateIntentsAsync

public final OperationFuture<BatchUpdateIntentsResponse,Struct> batchUpdateIntentsAsync(BatchUpdateIntentsRequest request)

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   BatchUpdateIntentsRequest request =
       BatchUpdateIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIntentView(IntentView.forNumber(0))
           .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

public final OperationCallable<BatchUpdateIntentsRequest,BatchUpdateIntentsResponse,Struct> batchUpdateIntentsOperationCallable()

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   BatchUpdateIntentsRequest request =
       BatchUpdateIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIntentView(IntentView.forNumber(0))
           .build();
   OperationFuture<BatchUpdateIntentsResponse, Struct> future =
       intentsClient.batchUpdateIntentsOperationCallable().futureCall(request);
   // Do something.
   BatchUpdateIntentsResponse response = future.get();
 }
 

batchUpdateIntentsCallable

public final UnaryCallable<BatchUpdateIntentsRequest,Operation> batchUpdateIntentsCallable()

Updates/Creates multiple intents in the specified agent.

Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   BatchUpdateIntentsRequest request =
       BatchUpdateIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIntentView(IntentView.forNumber(0))
           .build();
   ApiFuture<Operation> future = intentsClient.batchUpdateIntentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

batchDeleteIntentsAsync

public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(AgentName parent,
                                                                   List<Intent> intents)

Deletes intents in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   AgentName parent = AgentName.ofProjectName("[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. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location 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

public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(String parent,
                                                                   List<Intent> intents)

Deletes intents in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   String parent = IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString();
   List<Intent> intents = new ArrayList<>();
   intentsClient.batchDeleteIntentsAsync(parent, intents).get();
 }
 

Parameters:

parent - Required. The name of the agent to delete all entities types for. Supported formats:

- `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location 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

public final OperationFuture<Empty,Struct> batchDeleteIntentsAsync(BatchDeleteIntentsRequest request)

Deletes intents in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   BatchDeleteIntentsRequest request =
       BatchDeleteIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .addAllIntents(new ArrayList<Intent>())
           .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

public final OperationCallable<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()) {
   BatchDeleteIntentsRequest request =
       BatchDeleteIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .addAllIntents(new ArrayList<Intent>())
           .build();
   OperationFuture<Empty, Struct> future =
       intentsClient.batchDeleteIntentsOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

batchDeleteIntentsCallable

public final UnaryCallable<BatchDeleteIntentsRequest,Operation> batchDeleteIntentsCallable()

Deletes intents in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:

 try (IntentsClient intentsClient = IntentsClient.create()) {
   BatchDeleteIntentsRequest request =
       BatchDeleteIntentsRequest.newBuilder()
           .setParent(IntentName.ofProjectIntentName("[PROJECT]", "[INTENT]").toString())
           .addAllIntents(new ArrayList<Intent>())
           .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