ContextsClient (Google Cloud Dialog Flow API Parent 4.9.1 API)

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

All Implemented Interfaces:: BackgroundResource, AutoCloseable

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

Service Description: Service for managing [Contexts][google.cloud.dialogflow.v2.Context].

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ContextsClient contextsClient = ContextsClient.create()) {
   ContextName name =
       ContextName.ofProjectSessionContextName("[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:

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.
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.
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ContextsSettings contextsSettings =
     ContextsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContextsClient contextsClient = ContextsClient.create(contextsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ContextsSettings contextsSettings =
     ContextsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContextsClient contextsClient = ContextsClient.create(contextsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ContextsSettings contextsSettings =
     ContextsSettings.newBuilder()
         .setTransportChannelProvider(
             ContextsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ContextsClient contextsClient = ContextsClient.create(contextsSettings);

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`	`ContextsClient.ListContextsFixedSizeCollection`
`static class`	`ContextsClient.ListContextsPage`
`static class`	`ContextsClient.ListContextsPagedResponse`
`static class`	`ContextsClient.ListLocationsFixedSizeCollection`
`static class`	`ContextsClient.ListLocationsPage`
`static class`	`ContextsClient.ListLocationsPagedResponse`

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

All Methods Static Methods Instance Methods Concrete Methods
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.
`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.
`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.
`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.
`UnaryCallable<GetContextRequest,Context>`	`getContextCallable()` Retrieves the specified context.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`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.
`UnaryCallable<ListContextsRequest,ListContextsResponse>`	`listContextsCallable()` Returns the list of all contexts in the specified session.
`UnaryCallable<ListContextsRequest,ContextsClient.ListContextsPagedResponse>`	`listContextsPagedCallable()` Returns the list of all contexts in the specified session.
`ContextsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ContextsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Context`	`updateContext(Context context, FieldMask updateMask)` Updates the specified context.
`Context`	`updateContext(UpdateContextRequest request)` Updates the specified context.
`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
```
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
```
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 using create(ContextsSettings).

getSettings

public final ContextsSettings getSettings()

getStub
```
public ContextsStub getStub()
```