com.google.cloud.aiplatform.v1beta1

Class SessionServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1beta1.SessionServiceClient

All Implemented Interfaces:

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

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

Service Description: The service that manages Vertex Session related resources.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SessionName name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]");
   Session response = sessionServiceClient.getSession(name);
 }
 

Note: close() needs to be called on the SessionServiceClient 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
CreateSession	Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSessionAsync(CreateSessionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createSessionAsync(ReasoningEngineName parent, Session session) createSessionAsync(String parent, Session session) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSessionOperationCallable() createSessionCallable()
GetSession	Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSession(GetSessionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSession(SessionName name) getSession(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. getSessionCallable()
ListSessions	Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSessions(ListSessionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSessions(ReasoningEngineName parent) listSessions(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. listSessionsPagedCallable() listSessionsCallable()
UpdateSession	Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSession(UpdateSessionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateSession(Session session, 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. updateSessionCallable()
DeleteSession	Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSessionAsync(DeleteSessionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteSessionAsync(SessionName name) deleteSessionAsync(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. deleteSessionOperationCallable() deleteSessionCallable()
ListEvents	Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEvents(ListEventsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEvents(SessionName parent) listEvents(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. listEventsPagedCallable() listEventsCallable()
AppendEvent	Appends an event to a given session.	Request object method variants only take one parameter, a request object, which must be constructed before the call. appendEvent(AppendEventRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. appendEvent(SessionName name, SessionEvent event) appendEvent(String name, SessionEvent event) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. appendEventCallable()
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()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 SessionServiceSettings 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
 SessionServiceSettings sessionServiceSettings =
     SessionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionServiceClient sessionServiceClient = SessionServiceClient.create(sessionServiceSettings);
 

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
 SessionServiceSettings sessionServiceSettings =
     SessionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionServiceClient sessionServiceClient = SessionServiceClient.create(sessionServiceSettings);
 

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	SessionServiceClient.ListEventsFixedSizeCollection
static class	SessionServiceClient.ListEventsPage
static class	SessionServiceClient.ListEventsPagedResponse
static class	SessionServiceClient.ListLocationsFixedSizeCollection
static class	SessionServiceClient.ListLocationsPage
static class	SessionServiceClient.ListLocationsPagedResponse
static class	SessionServiceClient.ListSessionsFixedSizeCollection
static class	SessionServiceClient.ListSessionsPage
static class	SessionServiceClient.ListSessionsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionServiceClient(SessionServiceSettings settings) Constructs an instance of SessionServiceClient, using the given settings.
protected	SessionServiceClient(SessionServiceStub stub)

Method Summary

Modifier and Type	Method and Description
AppendEventResponse	appendEvent(AppendEventRequest request) Appends an event to a given session.
AppendEventResponse	appendEvent(SessionName name, SessionEvent event) Appends an event to a given session.
AppendEventResponse	appendEvent(String name, SessionEvent event) Appends an event to a given session.
com.google.api.gax.rpc.UnaryCallable<AppendEventRequest,AppendEventResponse>	appendEventCallable() Appends an event to a given session.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SessionServiceClient	create() Constructs an instance of SessionServiceClient with default settings.
static SessionServiceClient	create(SessionServiceSettings settings) Constructs an instance of SessionServiceClient, using the given settings.
static SessionServiceClient	create(SessionServiceStub stub) Constructs an instance of SessionServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata>	createSessionAsync(CreateSessionRequest request) Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata>	createSessionAsync(ReasoningEngineName parent, Session session) Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata>	createSessionAsync(String parent, Session session) Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.UnaryCallable<CreateSessionRequest,com.google.longrunning.Operation>	createSessionCallable() Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.OperationCallable<CreateSessionRequest,Session,CreateSessionOperationMetadata>	createSessionOperationCallable() Creates a new [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSessionAsync(DeleteSessionRequest request) Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSessionAsync(SessionName name) Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSessionAsync(String name) Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.UnaryCallable<DeleteSessionRequest,com.google.longrunning.Operation>	deleteSessionCallable() Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.OperationCallable<DeleteSessionRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSessionOperationCallable() Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the access control policy for a resource.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Session	getSession(GetSessionRequest request) Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
Session	getSession(SessionName name) Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
Session	getSession(String name) Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.UnaryCallable<GetSessionRequest,Session>	getSessionCallable() Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].
SessionServiceSettings	getSettings()
SessionServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
SessionServiceClient.ListEventsPagedResponse	listEvents(ListEventsRequest request) Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.
SessionServiceClient.ListEventsPagedResponse	listEvents(SessionName parent) Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.
SessionServiceClient.ListEventsPagedResponse	listEvents(String parent) Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.
com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ListEventsResponse>	listEventsCallable() Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.
com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,SessionServiceClient.ListEventsPagedResponse>	listEventsPagedCallable() Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.
SessionServiceClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,SessionServiceClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
SessionServiceClient.ListSessionsPagedResponse	listSessions(ListSessionsRequest request) Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.
SessionServiceClient.ListSessionsPagedResponse	listSessions(ReasoningEngineName parent) Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.
SessionServiceClient.ListSessionsPagedResponse	listSessions(String parent) Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.
com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,ListSessionsResponse>	listSessionsCallable() Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.
com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,SessionServiceClient.ListSessionsPagedResponse>	listSessionsPagedCallable() Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns permissions that a caller has on the specified resource.
Session	updateSession(Session session, com.google.protobuf.FieldMask updateMask) Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].
Session	updateSession(UpdateSessionRequest request) Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].
com.google.api.gax.rpc.UnaryCallable<UpdateSessionRequest,Session>	updateSessionCallable() Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionServiceClient

protected SessionServiceClient(SessionServiceSettings settings)
                        throws IOException

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

SessionServiceClient

protected SessionServiceClient(SessionServiceStub stub)

Method Detail

create

public static final SessionServiceClient create()
                                         throws IOException

Constructs an instance of SessionServiceClient with default settings.

Throws:

IOException

create

public static final SessionServiceClient create(SessionServiceSettings settings)
                                         throws IOException

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

Constructs an instance of SessionServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SessionServiceSettings).

getSettings

public final SessionServiceSettings getSettings()

getStub

public SessionServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata> createSessionAsync(ReasoningEngineName parent,
                                                                                                                       Session session)

Creates a new [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ReasoningEngineName parent =
       ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
   Session session = Session.newBuilder().build();
   Session response = sessionServiceClient.createSessionAsync(parent, session).get();
 }
 

Parameters:

parent - Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

session - Required. The session to create.

Throws:

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

createSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata> createSessionAsync(String parent,
                                                                                                                       Session session)

Creates a new [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String parent =
       ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]").toString();
   Session session = Session.newBuilder().build();
   Session response = sessionServiceClient.createSessionAsync(parent, session).get();
 }
 

Parameters:

parent - Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

session - Required. The session to create.

Throws:

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

createSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<Session,CreateSessionOperationMetadata> createSessionAsync(CreateSessionRequest request)

Creates a new [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setSession(Session.newBuilder().build())
           .build();
   Session response = sessionServiceClient.createSessionAsync(request).get();
 }
 

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

createSessionOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateSessionRequest,Session,CreateSessionOperationMetadata> createSessionOperationCallable()

Creates a new [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setSession(Session.newBuilder().build())
           .build();
   OperationFuture<Session, CreateSessionOperationMetadata> future =
       sessionServiceClient.createSessionOperationCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 

createSessionCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateSessionRequest,com.google.longrunning.Operation> createSessionCallable()

Creates a new [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setSession(Session.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       sessionServiceClient.createSessionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getSession

public final Session getSession(SessionName name)

Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SessionName name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]");
   Session response = sessionServiceClient.getSession(name);
 }
 

Parameters:

name - Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

getSession

public final Session getSession(String name)

Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]").toString();
   Session response = sessionServiceClient.getSession(name);
 }
 

Parameters:

name - Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

getSession

public final Session getSession(GetSessionRequest request)

Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .build();
   Session response = sessionServiceClient.getSession(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

getSessionCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSessionRequest,Session> getSessionCallable()

Gets details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .build();
   ApiFuture<Session> future = sessionServiceClient.getSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(ReasoningEngineName parent)

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ReasoningEngineName parent =
       ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
   for (Session element : sessionServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

Throws:

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

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(String parent)

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String parent =
       ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]").toString();
   for (Session element : sessionServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

Throws:

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

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Session element : sessionServiceClient.listSessions(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

listSessionsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,SessionServiceClient.ListSessionsPagedResponse> listSessionsPagedCallable()

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Session> future =
       sessionServiceClient.listSessionsPagedCallable().futureCall(request);
   // Do something.
   for (Session element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSessionsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,ListSessionsResponse> listSessionsCallable()

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given reasoning engine.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListSessionsResponse response = sessionServiceClient.listSessionsCallable().call(request);
     for (Session element : response.getSessionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

updateSession

public final Session updateSession(Session session,
                                   com.google.protobuf.FieldMask updateMask)

Updates the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   Session session = Session.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Session response = sessionServiceClient.updateSession(session, updateMask);
 }
 

Parameters:

session - Required. The session to update. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

updateMask - Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Throws:

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

updateSession

public final Session updateSession(UpdateSessionRequest request)

Updates the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   UpdateSessionRequest request =
       UpdateSessionRequest.newBuilder()
           .setSession(Session.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Session response = sessionServiceClient.updateSession(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

updateSessionCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateSessionRequest,Session> updateSessionCallable()

Updates the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   UpdateSessionRequest request =
       UpdateSessionRequest.newBuilder()
           .setSession(Session.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Session> future = sessionServiceClient.updateSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 

deleteSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSessionAsync(SessionName name)

Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SessionName name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]");
   sessionServiceClient.deleteSessionAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

deleteSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSessionAsync(String name)

Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]").toString();
   sessionServiceClient.deleteSessionAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

deleteSessionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteSessionAsync(DeleteSessionRequest request)

Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .build();
   sessionServiceClient.deleteSessionAsync(request).get();
 }
 

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

deleteSessionOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteSessionRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteSessionOperationCallable()

Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       sessionServiceClient.deleteSessionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteSessionCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteSessionRequest,com.google.longrunning.Operation> deleteSessionCallable()

Deletes details of the specific [Session][google.cloud.aiplatform.v1beta1.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       sessionServiceClient.deleteSessionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listEvents

public final SessionServiceClient.ListEventsPagedResponse listEvents(SessionName parent)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SessionName parent =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]");
   for (SessionEvent element : sessionServiceClient.listEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

listEvents

public final SessionServiceClient.ListEventsPagedResponse listEvents(String parent)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String parent =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]").toString();
   for (SessionEvent element : sessionServiceClient.listEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

Throws:

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

listEvents

public final SessionServiceClient.ListEventsPagedResponse listEvents(ListEventsRequest request)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SessionEvent element : sessionServiceClient.listEvents(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

listEventsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,SessionServiceClient.ListEventsPagedResponse> listEventsPagedCallable()

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SessionEvent> future =
       sessionServiceClient.listEventsPagedCallable().futureCall(request);
   // Do something.
   for (SessionEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ListEventsResponse> listEventsCallable()

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEventsResponse response = sessionServiceClient.listEventsCallable().call(request);
     for (SessionEvent element : response.getSessionEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

appendEvent

public final AppendEventResponse appendEvent(SessionName name,
                                             SessionEvent event)

Appends an event to a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SessionName name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]");
   SessionEvent event = SessionEvent.newBuilder().build();
   AppendEventResponse response = sessionServiceClient.appendEvent(name, event);
 }
 

Parameters:

name - Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

event - Required. The event to append to the session.

Throws:

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

appendEvent

public final AppendEventResponse appendEvent(String name,
                                             SessionEvent event)

Appends an event to a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   String name =
       SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]").toString();
   SessionEvent event = SessionEvent.newBuilder().build();
   AppendEventResponse response = sessionServiceClient.appendEvent(name, event);
 }
 

Parameters:

name - Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

event - Required. The event to append to the session.

Throws:

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

appendEvent

public final AppendEventResponse appendEvent(AppendEventRequest request)

Appends an event to a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   AppendEventRequest request =
       AppendEventRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .setEvent(SessionEvent.newBuilder().build())
           .build();
   AppendEventResponse response = sessionServiceClient.appendEvent(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

appendEventCallable

public final com.google.api.gax.rpc.UnaryCallable<AppendEventRequest,AppendEventResponse> appendEventCallable()

Appends an event to a given 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   AppendEventRequest request =
       AppendEventRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[SESSION]")
                   .toString())
           .setEvent(SessionEvent.newBuilder().build())
           .build();
   ApiFuture<AppendEventResponse> future =
       sessionServiceClient.appendEventCallable().futureCall(request);
   // Do something.
   AppendEventResponse response = future.get();
 }
 

listLocations

public final SessionServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : sessionServiceClient.listLocations(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

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,SessionServiceClient.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       sessionServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = sessionServiceClient.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;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = sessionServiceClient.getLocation(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

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = sessionServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = sessionServiceClient.setIamPolicy(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

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sessionServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = sessionServiceClient.getIamPolicy(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

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sessionServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = sessionServiceClient.testIamPermissions(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

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       sessionServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = 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