Class ContextsClient (4.60.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing Contexts.

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().

Methods
Method Description Method Variants

ListContexts

Returns the list of all contexts in the specified session.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listContexts(ListContextsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listContexts(SessionName parent)

  • listContexts(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listContextsPagedCallable()

  • listContextsCallable()

GetContext

Retrieves the specified context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getContext(GetContextRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getContext(ContextName name)

  • getContext(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getContextCallable()

CreateContext

Creates a context.

If the specified context already exists, overrides the context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createContext(CreateContextRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createContext(SessionName parent, Context context)

  • createContext(String parent, Context context)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createContextCallable()

UpdateContext

Updates the specified context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateContext(UpdateContextRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateContext(Context context)

  • updateContext(Context context, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateContextCallable()

DeleteContext

Deletes the specified context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteContext(DeleteContextRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteContext(ContextName name)

  • deleteContext(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteContextCallable()

DeleteAllContexts

Deletes all active contexts in the specified session.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAllContexts(DeleteAllContextsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAllContexts(SessionName parent)

  • deleteAllContexts(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAllContextsCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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.newHttpJsonBuilder().build();
 ContextsClient contextsClient = ContextsClient.create(contextsSettings);

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

Inheritance

java.lang.Object > ContextsClient

Static Methods

create()

public static final ContextsClient create()

Constructs an instance of ContextsClient with default settings.

Returns
Type Description
ContextsClient
Exceptions
Type Description
IOException

create(ContextsSettings settings)

public static final ContextsClient create(ContextsSettings settings)

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.

Parameter
Name Description
settings ContextsSettings
Returns
Type Description
ContextsClient
Exceptions
Type Description
IOException

create(ContextsStub stub)

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

Parameter
Name Description
stub ContextsStub
Returns
Type Description
ContextsClient

Constructors

ContextsClient(ContextsSettings settings)

protected ContextsClient(ContextsSettings settings)

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.

Parameter
Name Description
settings ContextsSettings

ContextsClient(ContextsStub stub)

protected ContextsClient(ContextsStub stub)
Parameter
Name Description
stub ContextsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createContext(CreateContextRequest request)

public final Context createContext(CreateContextRequest request)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:


 // 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()) {
   CreateContextRequest request =
       CreateContextRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setContext(Context.newBuilder().build())
           .build();
   Context response = contextsClient.createContext(request);
 }
Parameter
Name Description
request CreateContextRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Context

createContext(SessionName parent, Context context)

public final Context createContext(SessionName parent, Context context)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:


 // 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()) {
   SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
   Context context = Context.newBuilder().build();
   Context response = contextsClient.createContext(parent, context);
 }
Parameters
Name Description
parent SessionName

Required. The session to create a context for. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
context Context

Required. The context to create.
Returns
Type Description
Context

createContext(String parent, Context context)

public final Context createContext(String parent, Context context)

Creates a context.

If the specified context already exists, overrides the context.

Sample code:


 // 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()) {
   String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
   Context context = Context.newBuilder().build();
   Context response = contextsClient.createContext(parent, context);
 }
Parameters
Name Description
parent String

Required. The session to create a context for. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
context Context

Required. The context to create.
Returns
Type Description
Context

createContextCallable()

public final UnaryCallable<CreateContextRequest,Context> createContextCallable()

Creates a context.

If the specified context already exists, overrides the context.

Sample code:


 // 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()) {
   CreateContextRequest request =
       CreateContextRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setContext(Context.newBuilder().build())
           .build();
   ApiFuture<Context> future = contextsClient.createContextCallable().futureCall(request);
   // Do something.
   Context response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateContextRequest,Context>

deleteAllContexts(DeleteAllContextsRequest request)

public final void deleteAllContexts(DeleteAllContextsRequest request)

Deletes all active contexts in the specified session.

Sample code:


 // 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()) {
   DeleteAllContextsRequest request =
       DeleteAllContextsRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .build();
   contextsClient.deleteAllContexts(request);
 }
Parameter
Name Description
request DeleteAllContextsRequest

The request object containing all of the parameters for the API call.

deleteAllContexts(SessionName parent)

public final void deleteAllContexts(SessionName parent)

Deletes all active contexts in the specified session.

Sample code:


 // 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()) {
   SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
   contextsClient.deleteAllContexts(parent);
 }
Parameter
Name Description
parent SessionName

Required. The name of the session to delete all contexts from. Supported formats:

  • projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

    If Location ID is not specified we assume default 'us' location. If Environment ID is not specified we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.

deleteAllContexts(String parent)

public final void deleteAllContexts(String parent)

Deletes all active contexts in the specified session.

Sample code:


 // 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()) {
   String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
   contextsClient.deleteAllContexts(parent);
 }
Parameter
Name Description
parent String

Required. The name of the session to delete all contexts from. Supported formats:

  • projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

    If Location ID is not specified we assume default 'us' location. If Environment ID is not specified we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.

deleteAllContextsCallable()

public final UnaryCallable<DeleteAllContextsRequest,Empty> deleteAllContextsCallable()

Deletes all active contexts in the specified session.

Sample code:


 // 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()) {
   DeleteAllContextsRequest request =
       DeleteAllContextsRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .build();
   ApiFuture<Empty> future = contextsClient.deleteAllContextsCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAllContextsRequest,Empty>

deleteContext(ContextName name)

public final void deleteContext(ContextName name)

Deletes the specified context.

Sample code:


 // 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]");
   contextsClient.deleteContext(name);
 }
Parameter
Name Description
name ContextName

Required. The name of the context to delete. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

deleteContext(DeleteContextRequest request)

public final void deleteContext(DeleteContextRequest request)

Deletes the specified context.

Sample code:


 // 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()) {
   DeleteContextRequest request =
       DeleteContextRequest.newBuilder()
           .setName(
               ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
                   .toString())
           .build();
   contextsClient.deleteContext(request);
 }
Parameter
Name Description
request DeleteContextRequest

The request object containing all of the parameters for the API call.

deleteContext(String name)

public final void deleteContext(String name)

Deletes the specified context.

Sample code:


 // 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()) {
   String name =
       ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]").toString();
   contextsClient.deleteContext(name);
 }
Parameter
Name Description
name String

Required. The name of the context to delete. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

deleteContextCallable()

public final UnaryCallable<DeleteContextRequest,Empty> deleteContextCallable()

Deletes the specified context.

Sample code:


 // 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()) {
   DeleteContextRequest request =
       DeleteContextRequest.newBuilder()
           .setName(
               ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
                   .toString())
           .build();
   ApiFuture<Empty> future = contextsClient.deleteContextCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteContextRequest,Empty>

getContext(ContextName name)

public final Context getContext(ContextName name)

Retrieves the specified context.

Sample code:


 // 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);
 }
Parameter
Name Description
name ContextName

Required. The name of the context. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
Returns
Type Description
Context

getContext(GetContextRequest request)

public final Context getContext(GetContextRequest request)

Retrieves the specified context.

Sample code:


 // 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()) {
   GetContextRequest request =
       GetContextRequest.newBuilder()
           .setName(
               ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
                   .toString())
           .build();
   Context response = contextsClient.getContext(request);
 }
Parameter
Name Description
request GetContextRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Context

getContext(String name)

public final Context getContext(String name)

Retrieves the specified context.

Sample code:


 // 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()) {
   String name =
       ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]").toString();
   Context response = contextsClient.getContext(name);
 }
Parameter
Name Description
name String

Required. The name of the context. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
Returns
Type Description
Context

getContextCallable()

public final UnaryCallable<GetContextRequest,Context> getContextCallable()

Retrieves the specified context.

Sample code:


 // 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()) {
   GetContextRequest request =
       GetContextRequest.newBuilder()
           .setName(
               ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
                   .toString())
           .build();
   ApiFuture<Context> future = contextsClient.getContextCallable().futureCall(request);
   // Do something.
   Context response = future.get();
 }
Returns
Type Description
UnaryCallable<GetContextRequest,Context>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = contextsClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = contextsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final ContextsSettings getSettings()
Returns
Type Description
ContextsSettings

getStub()

public ContextsStub getStub()
Returns
Type Description
ContextsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listContexts(ListContextsRequest request)

public final ContextsClient.ListContextsPagedResponse listContexts(ListContextsRequest request)

Returns the list of all contexts in the specified session.

Sample code:


 // 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()) {
   ListContextsRequest request =
       ListContextsRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Context element : contextsClient.listContexts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListContextsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ContextsClient.ListContextsPagedResponse

listContexts(SessionName parent)

public final ContextsClient.ListContextsPagedResponse listContexts(SessionName parent)

Returns the list of all contexts in the specified session.

Sample code:


 // 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()) {
   SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
   for (Context element : contextsClient.listContexts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent SessionName

Required. The session to list all contexts from. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
Returns
Type Description
ContextsClient.ListContextsPagedResponse

listContexts(String parent)

public final ContextsClient.ListContextsPagedResponse listContexts(String parent)

Returns the list of all contexts in the specified session.

Sample code:


 // 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()) {
   String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
   for (Context element : contextsClient.listContexts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The session to list all contexts from. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
Returns
Type Description
ContextsClient.ListContextsPagedResponse

listContextsCallable()

public final UnaryCallable<ListContextsRequest,ListContextsResponse> listContextsCallable()

Returns the list of all contexts in the specified session.

Sample code:


 // 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()) {
   ListContextsRequest request =
       ListContextsRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListContextsRequest,ListContextsResponse>

listContextsPagedCallable()

public final UnaryCallable<ListContextsRequest,ContextsClient.ListContextsPagedResponse> listContextsPagedCallable()

Returns the list of all contexts in the specified session.

Sample code:


 // 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()) {
   ListContextsRequest request =
       ListContextsRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Context> future = contextsClient.listContextsPagedCallable().futureCall(request);
   // Do something.
   for (Context element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListContextsRequest,ListContextsPagedResponse>

listLocations(ListLocationsRequest request)

public final ContextsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : contextsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ContextsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = contextsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ContextsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = contextsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateContext(Context context)

public final Context updateContext(Context context)

Updates the specified context.

Sample code:


 // 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()) {
   Context context = Context.newBuilder().build();
   Context response = contextsClient.updateContext(context);
 }
Parameter
Name Description
context Context

Required. The context to update.
Returns
Type Description
Context

updateContext(Context context, FieldMask updateMask)

public final Context updateContext(Context context, FieldMask updateMask)

Updates the specified context.

Sample code:


 // 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()) {
   Context context = Context.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Context response = contextsClient.updateContext(context, updateMask);
 }
Parameters
Name Description
context Context

Required. The context to update.
updateMask FieldMask

Optional. The mask to control which fields get updated.
Returns
Type Description
Context

updateContext(UpdateContextRequest request)

public final Context updateContext(UpdateContextRequest request)

Updates the specified context.

Sample code:


 // 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()) {
   UpdateContextRequest request =
       UpdateContextRequest.newBuilder()
           .setContext(Context.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Context response = contextsClient.updateContext(request);
 }
Parameter
Name Description
request UpdateContextRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Context

updateContextCallable()

public final UnaryCallable<UpdateContextRequest,Context> updateContextCallable()

Updates the specified context.

Sample code:


 // 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()) {
   UpdateContextRequest request =
       UpdateContextRequest.newBuilder()
           .setContext(Context.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Context> future = contextsClient.updateContextCallable().futureCall(request);
   // Do something.
   Context response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateContextRequest,Context>