com.google.cloud.discoveryengine.v1

Class SessionServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.SessionServiceClient

All Implemented Interfaces:

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

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

Service Description: Service for managing Sessions and 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()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Session session = Session.newBuilder().build();
   Session response = sessionServiceClient.createSession(parent, session);
 }
 

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 Session. If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSession(CreateSessionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createSession(DataStoreName parent, Session session) createSession(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. createSessionCallable()
DeleteSession	Deletes a Session. If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSession(DeleteSessionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSession(SessionName name) deleteSession(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. deleteSessionCallable()
UpdateSession	Updates a Session. [Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.	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()
GetSession	Gets a 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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].	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(DataStoreName 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()

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

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
 SessionServiceSettings sessionServiceSettings =
     SessionServiceSettings.newHttpJsonBuilder().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.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
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.
Session	createSession(CreateSessionRequest request) Creates a Session.
Session	createSession(DataStoreName parent, Session session) Creates a Session.
Session	createSession(String parent, Session session) Creates a Session.
com.google.api.gax.rpc.UnaryCallable<CreateSessionRequest,Session>	createSessionCallable() Creates a Session.
void	deleteSession(DeleteSessionRequest request) Deletes a Session.
void	deleteSession(SessionName name) Deletes a Session.
void	deleteSession(String name) Deletes a Session.
com.google.api.gax.rpc.UnaryCallable<DeleteSessionRequest,com.google.protobuf.Empty>	deleteSessionCallable() Deletes a Session.
Session	getSession(GetSessionRequest request) Gets a Session.
Session	getSession(SessionName name) Gets a Session.
Session	getSession(String name) Gets a Session.
com.google.api.gax.rpc.UnaryCallable<GetSessionRequest,Session>	getSessionCallable() Gets a Session.
SessionServiceSettings	getSettings()
SessionServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
SessionServiceClient.ListSessionsPagedResponse	listSessions(DataStoreName parent) Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
SessionServiceClient.ListSessionsPagedResponse	listSessions(ListSessionsRequest request) Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
SessionServiceClient.ListSessionsPagedResponse	listSessions(String parent) Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,ListSessionsResponse>	listSessionsCallable() Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListSessionsRequest,SessionServiceClient.ListSessionsPagedResponse>	listSessionsPagedCallable() Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
void	shutdown()
void	shutdownNow()
Session	updateSession(Session session, com.google.protobuf.FieldMask updateMask) Updates a Session.
Session	updateSession(UpdateSessionRequest request) Updates a Session.
com.google.api.gax.rpc.UnaryCallable<UpdateSessionRequest,Session>	updateSessionCallable() Updates a 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()

createSession

public final Session createSession(DataStoreName parent,
                                   Session session)

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Session session = Session.newBuilder().build();
   Session response = sessionServiceClient.createSession(parent, session);
 }
 

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`

session - Required. The session to create.

Throws:

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

createSession

public final Session createSession(String parent,
                                   Session session)

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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 =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   Session session = Session.newBuilder().build();
   Session response = sessionServiceClient.createSession(parent, session);
 }
 

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`

session - Required. The session to create.

Throws:

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

createSession

public final Session createSession(CreateSessionRequest request)

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setSession(Session.newBuilder().build())
           .build();
   Session response = sessionServiceClient.createSession(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

createSessionCallable

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

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setSession(Session.newBuilder().build())
           .build();
   ApiFuture<Session> future = sessionServiceClient.createSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 

deleteSession

public final void deleteSession(SessionName name)

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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.ofProjectLocationDataStoreSessionName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]");
   sessionServiceClient.deleteSession(name);
 }
 

Parameters:

name - Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Throws:

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

deleteSession

public final void deleteSession(String name)

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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.ofProjectLocationDataStoreSessionName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
           .toString();
   sessionServiceClient.deleteSession(name);
 }
 

Parameters:

name - Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Throws:

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

deleteSession

public final void deleteSession(DeleteSessionRequest request)

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .build();
   sessionServiceClient.deleteSession(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

deleteSessionCallable

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

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .build();
   ApiFuture<Empty> future = sessionServiceClient.deleteSessionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

updateSession

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

Updates a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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.

updateMask - Indicates which fields in the provided [Session][google.cloud.discoveryengine.v1.Session] to update. The following are NOT supported:

• [Session.name][google.cloud.discoveryengine.v1.Session.name]

If not set or empty, all supported fields are updated.

Throws:

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

updateSession

public final Session updateSession(UpdateSessionRequest request)

Updates a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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 a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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();
 }
 

getSession

public final Session getSession(SessionName name)

Gets a 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.ofProjectLocationDataStoreSessionName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]");
   Session response = sessionServiceClient.getSession(name);
 }
 

Parameters:

name - Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Throws:

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

getSession

public final Session getSession(String name)

Gets a 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.ofProjectLocationDataStoreSessionName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
           .toString();
   Session response = sessionServiceClient.getSession(name);
 }
 

Parameters:

name - Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Throws:

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

getSession

public final Session getSession(GetSessionRequest request)

Gets a 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.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .setIncludeAnswerDetails(true)
           .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 a 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.ofProjectLocationDataStoreSessionName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
                   .toString())
           .setIncludeAnswerDetails(true)
           .build();
   ApiFuture<Session> future = sessionServiceClient.getSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(DataStoreName parent)

Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (Session element : sessionServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`

Throws:

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

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(String parent)

Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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 =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (Session element : sessionServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`

Throws:

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

listSessions

public final SessionServiceClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)

Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .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;
     }
   }
 }
 

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