com.google.cloud.dialogflow.v2beta1

Class ContextsClient

java.lang.Object

com.google.cloud.dialogflow.v2beta1.ContextsClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class ContextsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.

You can include contexts as input parameters of a [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) request, or as output contexts included in the returned intent. Contexts expire when an intent is matched, after the number of `DetectIntent` requests specified by the `lifespan_count` parameter, or after 20 minutes if no intents are matched for a `DetectIntent` request.

For more information about contexts, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/contexts-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 (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   Context response = contextsClient.getContext(name);
 }
 
 

Note: close() needs to be called on the contextsClient 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 ContextsSettings to create(). For example:

To customize credentials:

 
 ContextsSettings contextsSettings =
     ContextsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContextsClient contextsClient =
     ContextsClient.create(contextsSettings);
 
 

To customize the endpoint:

 
 ContextsSettings contextsSettings =
     ContextsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContextsClient contextsClient =
     ContextsClient.create(contextsSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextsClient.ListContextsFixedSizeCollection
static class	ContextsClient.ListContextsPage
static class	ContextsClient.ListContextsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextsClient(ContextsSettings settings) Constructs an instance of ContextsClient, using the given settings.
protected	ContextsClient(ContextsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ContextsClient	create() Constructs an instance of ContextsClient with default settings.
static ContextsClient	create(ContextsSettings settings) Constructs an instance of ContextsClient, using the given settings.
static ContextsClient	create(ContextsStub stub) Constructs an instance of ContextsClient, using the given stub for making calls.
Context	createContext(CreateContextRequest request) Creates a context.
Context	createContext(SessionName parent, Context context) Creates a context.
Context	createContext(String parent, Context context) Creates a context.
com.google.api.gax.rpc.UnaryCallable<CreateContextRequest,Context>	createContextCallable() Creates a context.
void	deleteAllContexts(DeleteAllContextsRequest request) Deletes all active contexts in the specified session.
void	deleteAllContexts(SessionName parent) Deletes all active contexts in the specified session.
void	deleteAllContexts(String parent) Deletes all active contexts in the specified session.
com.google.api.gax.rpc.UnaryCallable<DeleteAllContextsRequest,Empty>	deleteAllContextsCallable() Deletes all active contexts in the specified session.
void	deleteContext(ContextName name) Deletes the specified context.
void	deleteContext(DeleteContextRequest request) Deletes the specified context.
void	deleteContext(String name) Deletes the specified context.
com.google.api.gax.rpc.UnaryCallable<DeleteContextRequest,Empty>	deleteContextCallable() Deletes the specified context.
Context	getContext(ContextName name) Retrieves the specified context.
Context	getContext(GetContextRequest request) Retrieves the specified context.
Context	getContext(String name) Retrieves the specified context.
com.google.api.gax.rpc.UnaryCallable<GetContextRequest,Context>	getContextCallable() Retrieves the specified context.
ContextsSettings	getSettings()
ContextsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ContextsClient.ListContextsPagedResponse	listContexts(ListContextsRequest request) Returns the list of all contexts in the specified session.
ContextsClient.ListContextsPagedResponse	listContexts(SessionName parent) Returns the list of all contexts in the specified session.
ContextsClient.ListContextsPagedResponse	listContexts(String parent) Returns the list of all contexts in the specified session.
com.google.api.gax.rpc.UnaryCallable<ListContextsRequest,ListContextsResponse>	listContextsCallable() Returns the list of all contexts in the specified session.
com.google.api.gax.rpc.UnaryCallable<ListContextsRequest,ContextsClient.ListContextsPagedResponse>	listContextsPagedCallable() Returns the list of all contexts in the specified session.
void	shutdown()
void	shutdownNow()
Context	updateContext(Context context) Updates the specified context.
Context	updateContext(UpdateContextRequest request) Updates the specified context.
com.google.api.gax.rpc.UnaryCallable<UpdateContextRequest,Context>	updateContextCallable() Updates the specified context.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextsClient

protected ContextsClient(ContextsSettings settings)
                  throws IOException

Constructs an instance of ContextsClient, 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

ContextsClient

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

Method Detail

create

public static final ContextsClient create()
                                   throws IOException

Constructs an instance of ContextsClient with default settings.

Throws:

IOException

create

public static final ContextsClient create(ContextsSettings settings)
                                   throws IOException

Constructs an instance of ContextsClient, 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 ContextsClient create(ContextsStub stub)

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

getSettings

public final ContextsSettings getSettings()

getStub

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

listContexts

public final ContextsClient.ListContextsPagedResponse listContexts(SessionName parent)

Returns the list of all contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   for (Context element : contextsClient.listContexts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listContexts

public final ContextsClient.ListContextsPagedResponse listContexts(String parent)

Returns the list of all contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   for (Context element : contextsClient.listContexts(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listContexts

public final ContextsClient.ListContextsPagedResponse listContexts(ListContextsRequest request)

Returns the list of all contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListContextsRequest request = ListContextsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Context element : contextsClient.listContexts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listContextsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListContextsRequest,ContextsClient.ListContextsPagedResponse> listContextsPagedCallable()

Returns the list of all contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListContextsRequest request = ListContextsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListContextsPagedResponse> future = contextsClient.listContextsPagedCallable().futureCall(request);
   // Do something
   for (Context element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listContextsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListContextsRequest,ListContextsResponse> listContextsCallable()

Returns the list of all contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListContextsRequest request = ListContextsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListContextsResponse response = contextsClient.listContextsCallable().call(request);
     for (Context element : response.getContextsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getContext

public final Context getContext(ContextName name)

Retrieves the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   Context response = contextsClient.getContext(name);
 }
 

Parameters:

name - Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getContext

public final Context getContext(String name)

Retrieves the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   Context response = contextsClient.getContext(name.toString());
 }
 

Parameters:

name - Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getContext

public final Context getContext(GetContextRequest request)

Retrieves the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   GetContextRequest request = GetContextRequest.newBuilder()
     .setName(name.toString())
     .build();
   Context response = contextsClient.getContext(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

getContextCallable

public final com.google.api.gax.rpc.UnaryCallable<GetContextRequest,Context> getContextCallable()

Retrieves the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   GetContextRequest request = GetContextRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Context> future = contextsClient.getContextCallable().futureCall(request);
   // Do something
   Context response = future.get();
 }
 

createContext

public final Context createContext(SessionName parent,
                                   Context context)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   Context context = Context.newBuilder().build();
   Context response = contextsClient.createContext(parent, context);
 }
 

Parameters:

parent - Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

context - Required. The context to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createContext

public final Context createContext(String parent,
                                   Context context)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   Context context = Context.newBuilder().build();
   Context response = contextsClient.createContext(parent.toString(), context);
 }
 

Parameters:

parent - Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

context - Required. The context to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createContext

public final Context createContext(CreateContextRequest request)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   Context context = Context.newBuilder().build();
   CreateContextRequest request = CreateContextRequest.newBuilder()
     .setParent(parent.toString())
     .setContext(context)
     .build();
   Context response = contextsClient.createContext(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

createContextCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateContextRequest,Context> createContextCallable()

Creates a context.

If the specified context already exists, overrides the context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   Context context = Context.newBuilder().build();
   CreateContextRequest request = CreateContextRequest.newBuilder()
     .setParent(parent.toString())
     .setContext(context)
     .build();
   ApiFuture<Context> future = contextsClient.createContextCallable().futureCall(request);
   // Do something
   Context response = future.get();
 }
 

updateContext

public final Context updateContext(Context context)

Updates the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   Context context = Context.newBuilder().build();
   Context response = contextsClient.updateContext(context);
 }
 

Parameters:

context - Required. The context to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateContext

public final Context updateContext(UpdateContextRequest request)

Updates the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   Context context = Context.newBuilder().build();
   UpdateContextRequest request = UpdateContextRequest.newBuilder()
     .setContext(context)
     .build();
   Context response = contextsClient.updateContext(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

updateContextCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateContextRequest,Context> updateContextCallable()

Updates the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   Context context = Context.newBuilder().build();
   UpdateContextRequest request = UpdateContextRequest.newBuilder()
     .setContext(context)
     .build();
   ApiFuture<Context> future = contextsClient.updateContextCallable().futureCall(request);
   // Do something
   Context response = future.get();
 }
 

deleteContext

public final void deleteContext(ContextName name)

Deletes the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   contextsClient.deleteContext(name);
 }
 

Parameters:

name - Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteContext

public final void deleteContext(String name)

Deletes the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   contextsClient.deleteContext(name.toString());
 }
 

Parameters:

name - Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteContext

public final void deleteContext(DeleteContextRequest request)

Deletes the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   DeleteContextRequest request = DeleteContextRequest.newBuilder()
     .setName(name.toString())
     .build();
   contextsClient.deleteContext(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

deleteContextCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteContextRequest,Empty> deleteContextCallable()

Deletes the specified context.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name = ContextName.of("[PROJECT]", "[SESSION]", "[CONTEXT]");
   DeleteContextRequest request = DeleteContextRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = contextsClient.deleteContextCallable().futureCall(request);
   // Do something
   future.get();
 }
 

deleteAllContexts

public final void deleteAllContexts(SessionName parent)

Deletes all active contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   contextsClient.deleteAllContexts(parent);
 }
 

Parameters:

parent - Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAllContexts

public final void deleteAllContexts(String parent)

Deletes all active contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   contextsClient.deleteAllContexts(parent.toString());
 }
 

Parameters:

parent - Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAllContexts

public final void deleteAllContexts(DeleteAllContextsRequest request)

Deletes all active contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   DeleteAllContextsRequest request = DeleteAllContextsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   contextsClient.deleteAllContexts(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

deleteAllContextsCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAllContextsRequest,Empty> deleteAllContextsCallable()

Deletes all active contexts in the specified session.

Sample code:

 try (ContextsClient contextsClient = ContextsClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   DeleteAllContextsRequest request = DeleteAllContextsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Void> future = contextsClient.deleteAllContextsCallable().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 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