IntentsClient (Google Cloud Dialog Flow API Parent 2.0.0 API)

java.lang.Object
- com.google.cloud.dialogflow.v2beta1.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.v2beta1.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.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/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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`OperationFuture<Empty,Struct>`	`batchDeleteIntentsAsync(BatchDeleteIntentsRequest request)` Deletes intents in the specified agent.
`OperationFuture<Empty,Struct>`	`batchDeleteIntentsAsync(ProjectAgentName parent, List<Intent> intents)` 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(BatchUpdateIntentsRequest request)` 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(CreateIntentRequest request)` Creates an intent in the specified agent.
`Intent`	`createIntent(ProjectAgentName parent, Intent intent)` Creates an intent in the specified agent.
`Intent`	`createIntent(ProjectAgentName parent, Intent intent, String languageCode)` 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(ListIntentsRequest request)` Returns the list of all intents in the specified agent.
`IntentsClient.ListIntentsPagedResponse`	`listIntents(ProjectAgentName parent)` Returns the list of all intents in the specified agent.
`IntentsClient.ListIntentsPagedResponse`	`listIntents(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<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, 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 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.