SessionsClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.dialogflow.v2.SessionsClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class SessionsClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method to determine user intent and respond.
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 (SessionsClient sessionsClient = SessionsClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[SESSION]");
   QueryInput queryInput = QueryInput.newBuilder().build();
   DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
 }
 
 
```
Note: close() needs to be called on the sessionsClient 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 SessionsSettings to create(). For example:
To customize credentials:
```
 
 SessionsSettings sessionsSettings =
     SessionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionsClient sessionsClient =
     SessionsClient.create(sessionsSettings);
 
 
```
To customize the endpoint:
```
 
 SessionsSettings sessionsSettings =
     SessionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionsClient sessionsClient =
     SessionsClient.create(sessionsSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SessionsClient(SessionsSettings settings)` Constructs an instance of SessionsClient, using the given settings.
`protected`	`SessionsClient(SessionsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SessionsClient`	`create()` Constructs an instance of SessionsClient with default settings.
`static SessionsClient`	`create(SessionsSettings settings)` Constructs an instance of SessionsClient, using the given settings.
`static SessionsClient`	`create(SessionsStub stub)` Constructs an instance of SessionsClient, using the given stub for making calls.
`DetectIntentResponse`	`detectIntent(DetectIntentRequest request)` Processes a natural language query and returns structured, actionable data as a result.
`DetectIntentResponse`	`detectIntent(SessionName session, QueryInput queryInput)` Processes a natural language query and returns structured, actionable data as a result.
`DetectIntentResponse`	`detectIntent(String session, QueryInput queryInput)` Processes a natural language query and returns structured, actionable data as a result.
`com.google.api.gax.rpc.UnaryCallable<DetectIntentRequest,DetectIntentResponse>`	`detectIntentCallable()` Processes a natural language query and returns structured, actionable data as a result.
`SessionsSettings`	`getSettings()`
`SessionsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.rpc.BidiStreamingCallable<StreamingDetectIntentRequest,StreamingDetectIntentResponse>`	`streamingDetectIntentCallable()` Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SessionsClient
```
protected SessionsClient(SessionsSettings settings)
                  throws IOException
```
    Constructs an instance of SessionsClient, 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
  - SessionsClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SessionsClient(SessionsStub stub)
```
- Method Detail
  - create
```
public static final SessionsClient create()
                                   throws IOException
```
    Constructs an instance of SessionsClient with default settings.
    
    Throws:
    
    IOException
  - create
```
public static final SessionsClient create(SessionsSettings settings)
                                   throws IOException
```
    Constructs an instance of SessionsClient, 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 SessionsClient create(SessionsStub stub)
```
    Constructs an instance of SessionsClient, using the given stub for making calls. This is for advanced usage - prefer to use SessionsSettings}.
  - getSettings
```
public final SessionsSettings getSettings()
```
  - getStub
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SessionsStub getStub()
```
  - detectIntent
```
public final DetectIntentResponse detectIntent(SessionName session,
                                               QueryInput queryInput)
```
    Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
    Sample code:
```
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[SESSION]");
   QueryInput queryInput = QueryInput.newBuilder().build();
   DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
 }
 
```
    Parameters:
    
    session - Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes.
    
    queryInput - Required. The input specification. It can be set to:
    1. an audio config which instructs the speech recognizer how to process the speech audio,
    2. a conversational query in the form of text, or
    3. an event that specifies which intent to trigger.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - detectIntent
```
public final DetectIntentResponse detectIntent(String session,
                                               QueryInput queryInput)
```
    Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
    Sample code:
```
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[SESSION]");
   QueryInput queryInput = QueryInput.newBuilder().build();
   DetectIntentResponse response = sessionsClient.detectIntent(session.toString(), queryInput);
 }
 
```
    Parameters:
    
    session - Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes.
    
    queryInput - Required. The input specification. It can be set to:
    1. an audio config which instructs the speech recognizer how to process the speech audio,
    2. a conversational query in the form of text, or
    3. an event that specifies which intent to trigger.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - detectIntent
```
public final DetectIntentResponse detectIntent(DetectIntentRequest request)
```
    Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
    Sample code:
```
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[SESSION]");
   QueryInput queryInput = QueryInput.newBuilder().build();
   DetectIntentRequest request = DetectIntentRequest.newBuilder()
     .setSession(session.toString())
     .setQueryInput(queryInput)
     .build();
   DetectIntentResponse response = sessionsClient.detectIntent(request);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - detectIntentCallable
```
public final com.google.api.gax.rpc.UnaryCallable<DetectIntentRequest,DetectIntentResponse> detectIntentCallable()
```
    Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
    Sample code:
```
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[SESSION]");
   QueryInput queryInput = QueryInput.newBuilder().build();
   DetectIntentRequest request = DetectIntentRequest.newBuilder()
     .setSession(session.toString())
     .setQueryInput(queryInput)
     .build();
   ApiFuture<DetectIntentResponse> future = sessionsClient.detectIntentCallable().futureCall(request);
   // Do something
   DetectIntentResponse response = future.get();
 }
 
```
  - streamingDetectIntentCallable
```
public final com.google.api.gax.rpc.BidiStreamingCallable<StreamingDetectIntentRequest,StreamingDetectIntentResponse> streamingDetectIntentCallable()
```
    Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
    Sample code:
```
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   BidiStream<StreamingDetectIntentRequest, StreamingDetectIntentResponse> bidiStream =
       sessionsClient.streamingDetectIntentCallable().call();

   String session = "";
   QueryInput queryInput = QueryInput.newBuilder().build();
   StreamingDetectIntentRequest request = StreamingDetectIntentRequest.newBuilder()
     .setSession(session)
     .setQueryInput(queryInput)
     .build();
   bidiStream.send(request);
   for (StreamingDetectIntentResponse response : bidiStream) {
     // Do something when receive a response
   }
 }
 
```
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface com.google.api.gax.core.BackgroundResource
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface com.google.api.gax.core.BackgroundResource
  - isTerminated
```
public boolean isTerminated()
```
    Specified by:
    
    isTerminated in interface com.google.api.gax.core.BackgroundResource
  - shutdownNow
```
public void shutdownNow()
```
    Specified by:
    
    shutdownNow in interface com.google.api.gax.core.BackgroundResource
  - awaitTermination
```
public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException
```
    Specified by:
    
    awaitTermination in interface com.google.api.gax.core.BackgroundResource
    
    Throws:
    
    InterruptedException

Class SessionsClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionsClient

SessionsClient

Method Detail

create

create

create

getSettings

getStub

detectIntent

detectIntent

detectIntent

detectIntentCallable

streamingDetectIntentCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination