- 0.66.0 (latest)
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
GitHub Repository | Product Reference |
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().
Method | Description | Method Variants |
---|---|---|
CreateSession |
Creates a Session. If the 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteSession |
Deletes a Session. If the 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateSession |
Updates a Session. Session action type cannot be changed. If the 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetSession |
Gets a Session. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListSessions |
Lists all Sessions by their parent DataStore. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListFiles |
Lists metadata for all files in the current session. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
Static Methods
create()
public static final SessionServiceClient create()
Constructs an instance of SessionServiceClient with default settings.
Returns | |
---|---|
Type | Description |
SessionServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(SessionServiceSettings settings)
public static final SessionServiceClient create(SessionServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
SessionServiceSettings |
Returns | |
---|---|
Type | Description |
SessionServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(SessionServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
SessionServiceStub |
Returns | |
---|---|
Type | Description |
SessionServiceClient |
Constructors
SessionServiceClient(SessionServiceSettings settings)
protected SessionServiceClient(SessionServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
SessionServiceSettings |
SessionServiceClient(SessionServiceStub stub)
protected SessionServiceClient(SessionServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
SessionServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createSession(CreateSessionRequest request)
public final Session createSession(CreateSessionRequest request)
Creates a Session.
If the 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);
}
Parameter | |
---|---|
Name | Description |
request |
CreateSessionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Session |
createSession(DataStoreName parent, Session session)
public final Session createSession(DataStoreName parent, Session session)
Creates a Session.
If the 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 | |
---|---|
Name | Description |
parent |
DataStoreName Required. Full resource name of parent data store. Format:
|
session |
Session Required. The session to create. |
Returns | |
---|---|
Type | Description |
Session |
createSession(String parent, Session session)
public final Session createSession(String parent, Session session)
Creates a Session.
If the 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 | |
---|---|
Name | Description |
parent |
String Required. Full resource name of parent data store. Format:
|
session |
Session Required. The session to create. |
Returns | |
---|---|
Type | Description |
Session |
createSessionCallable()
public final UnaryCallable<CreateSessionRequest,Session> createSessionCallable()
Creates a Session.
If the 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateSessionRequest,Session> |
deleteSession(DeleteSessionRequest request)
public final void deleteSession(DeleteSessionRequest request)
Deletes a Session.
If the 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);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteSessionRequest The request object containing all of the parameters for the API call. |
deleteSession(SessionName name)
public final void deleteSession(SessionName name)
Deletes a Session.
If the 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);
}
Parameter | |
---|---|
Name | Description |
name |
SessionName Required. The resource name of the Session to delete. Format:
|
deleteSession(String name)
public final void deleteSession(String name)
Deletes a Session.
If the 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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the Session to delete. Format:
|
deleteSessionCallable()
public final UnaryCallable<DeleteSessionRequest,Empty> deleteSessionCallable()
Deletes a Session.
If the 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteSessionRequest,Empty> |
getSession(GetSessionRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetSessionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Session |
getSession(SessionName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
SessionName Required. The resource name of the Session to get. Format:
|
Returns | |
---|---|
Type | Description |
Session |
getSession(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the Session to get. Format:
|
Returns | |
---|---|
Type | Description |
Session |
getSessionCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetSessionRequest,Session> |
getSettings()
public final SessionServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
SessionServiceSettings |
getStub()
public SessionServiceStub getStub()
Returns | |
---|---|
Type | Description |
SessionServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listFiles(ListFilesRequest request)
public final SessionServiceClient.ListFilesPagedResponse listFiles(ListFilesRequest request)
Lists metadata for all files in the current 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()) {
ListFilesRequest request =
ListFilesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationCollectionEngineSessionName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[SESSION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (FileMetadata element : sessionServiceClient.listFiles(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListFilesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListFilesPagedResponse |
listFiles(SessionName parent)
public final SessionServiceClient.ListFilesPagedResponse listFiles(SessionName parent)
Lists metadata for all files in the current 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.ofProjectLocationCollectionEngineSessionName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[SESSION]");
for (FileMetadata element : sessionServiceClient.listFiles(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
SessionName Required. The resource name of the Session. Format:
|
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListFilesPagedResponse |
listFiles(String parent)
public final SessionServiceClient.ListFilesPagedResponse listFiles(String parent)
Lists metadata for all files in the current 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.ofProjectLocationDataStoreSessionName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
.toString();
for (FileMetadata element : sessionServiceClient.listFiles(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the Session. Format:
|
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListFilesPagedResponse |
listFilesCallable()
public final UnaryCallable<ListFilesRequest,ListFilesResponse> listFilesCallable()
Lists metadata for all files in the current 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()) {
ListFilesRequest request =
ListFilesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationCollectionEngineSessionName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[SESSION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListFilesResponse response = sessionServiceClient.listFilesCallable().call(request);
for (FileMetadata element : response.getFilesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListFilesRequest,ListFilesResponse> |
listFilesPagedCallable()
public final UnaryCallable<ListFilesRequest,SessionServiceClient.ListFilesPagedResponse> listFilesPagedCallable()
Lists metadata for all files in the current 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()) {
ListFilesRequest request =
ListFilesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationCollectionEngineSessionName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[SESSION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<FileMetadata> future =
sessionServiceClient.listFilesPagedCallable().futureCall(request);
// Do something.
for (FileMetadata element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListFilesRequest,ListFilesPagedResponse> |
listSessions(DataStoreName parent)
public final SessionServiceClient.ListSessionsPagedResponse listSessions(DataStoreName parent)
Lists all Sessions by their parent 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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
DataStoreName Required. The data store resource name. Format:
|
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListSessionsPagedResponse |
listSessions(ListSessionsRequest request)
public final SessionServiceClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)
Lists all Sessions by their parent 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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListSessionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListSessionsPagedResponse |
listSessions(String parent)
public final SessionServiceClient.ListSessionsPagedResponse listSessions(String parent)
Lists all Sessions by their parent 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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The data store resource name. Format:
|
Returns | |
---|---|
Type | Description |
SessionServiceClient.ListSessionsPagedResponse |
listSessionsCallable()
public final UnaryCallable<ListSessionsRequest,ListSessionsResponse> listSessionsCallable()
Lists all Sessions by their parent 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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSessionsRequest,ListSessionsResponse> |
listSessionsPagedCallable()
public final UnaryCallable<ListSessionsRequest,SessionServiceClient.ListSessionsPagedResponse> listSessionsPagedCallable()
Lists all Sessions by their parent 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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSessionsRequest,ListSessionsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateSession(Session session, FieldMask updateMask)
public final Session updateSession(Session session, FieldMask updateMask)
Updates a Session.
Session action type cannot be changed. If the 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 | |
---|---|
Name | Description |
session |
Session Required. The Session to update. |
updateMask |
FieldMask Indicates which fields in the provided Session to update. The following are NOT supported:
If not set or empty, all supported fields are updated. |
Returns | |
---|---|
Type | Description |
Session |
updateSession(UpdateSessionRequest request)
public final Session updateSession(UpdateSessionRequest request)
Updates a Session.
Session action type cannot be changed. If the 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);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateSessionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Session |
updateSessionCallable()
public final UnaryCallable<UpdateSessionRequest,Session> updateSessionCallable()
Updates a Session.
Session action type cannot be changed. If the 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateSessionRequest,Session> |