Class SessionControllerClient (4.48.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: The SessionController provides methods to manage interactive sessions.

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

Note: close() needs to be called on the SessionControllerClient 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

Create an interactive session asynchronously.

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(LocationName parent, Session session, String sessionId)

  • createSessionAsync(String parent, Session session, String sessionId)

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 the resource representation for an interactive 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 interactive sessions.

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

TerminateSession

Terminates the interactive session.

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

  • terminateSessionAsync(TerminateSessionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • terminateSessionAsync(SessionName name)

  • terminateSessionAsync(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.

  • terminateSessionOperationCallable()

  • terminateSessionCallable()

DeleteSession

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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

SetIamPolicy

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 SessionControllerSettings 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
 SessionControllerSettings sessionControllerSettings =
     SessionControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionControllerClient sessionControllerClient =
     SessionControllerClient.create(sessionControllerSettings);

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
 SessionControllerSettings sessionControllerSettings =
     SessionControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionControllerClient sessionControllerClient =
     SessionControllerClient.create(sessionControllerSettings);

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
 SessionControllerSettings sessionControllerSettings =
     SessionControllerSettings.newHttpJsonBuilder().build();
 SessionControllerClient sessionControllerClient =
     SessionControllerClient.create(sessionControllerSettings);

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

Inheritance

java.lang.Object > SessionControllerClient

Static Methods

create()

public static final SessionControllerClient create()

Constructs an instance of SessionControllerClient with default settings.

Returns
Type Description
SessionControllerClient
Exceptions
Type Description
IOException

create(SessionControllerSettings settings)

public static final SessionControllerClient create(SessionControllerSettings settings)

Constructs an instance of SessionControllerClient, 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 SessionControllerSettings
Returns
Type Description
SessionControllerClient
Exceptions
Type Description
IOException

create(SessionControllerStub stub)

public static final SessionControllerClient create(SessionControllerStub stub)

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

Parameter
Name Description
stub SessionControllerStub
Returns
Type Description
SessionControllerClient

Constructors

SessionControllerClient(SessionControllerSettings settings)

protected SessionControllerClient(SessionControllerSettings settings)

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

SessionControllerClient(SessionControllerStub stub)

protected SessionControllerClient(SessionControllerStub stub)
Parameter
Name Description
stub SessionControllerStub

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

createSessionAsync(CreateSessionRequest request)

public final OperationFuture<Session,SessionOperationMetadata> createSessionAsync(CreateSessionRequest request)

Create an interactive session asynchronously.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSession(Session.newBuilder().build())
           .setSessionId("sessionId607796817")
           .setRequestId("requestId693933066")
           .build();
   Session response = sessionControllerClient.createSessionAsync(request).get();
 }
Parameter
Name Description
request CreateSessionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

createSessionAsync(LocationName parent, Session session, String sessionId)

public final OperationFuture<Session,SessionOperationMetadata> createSessionAsync(LocationName parent, Session session, String sessionId)

Create an interactive session asynchronously.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Session session = Session.newBuilder().build();
   String sessionId = "sessionId607796817";
   Session response =
       sessionControllerClient.createSessionAsync(parent, session, sessionId).get();
 }
Parameters
Name Description
parent LocationName

Required. The parent resource where this session will be created.
session Session

Required. The interactive session to create.
sessionId String

Required. The ID to use for the session, which becomes the final component of the session's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

createSessionAsync(String parent, Session session, String sessionId)

public final OperationFuture<Session,SessionOperationMetadata> createSessionAsync(String parent, Session session, String sessionId)

Create an interactive session asynchronously.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Session session = Session.newBuilder().build();
   String sessionId = "sessionId607796817";
   Session response =
       sessionControllerClient.createSessionAsync(parent, session, sessionId).get();
 }
Parameters
Name Description
parent String

Required. The parent resource where this session will be created.
session Session

Required. The interactive session to create.
sessionId String

Required. The ID to use for the session, which becomes the final component of the session's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

createSessionCallable()

public final UnaryCallable<CreateSessionRequest,Operation> createSessionCallable()

Create an interactive session asynchronously.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSession(Session.newBuilder().build())
           .setSessionId("sessionId607796817")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sessionControllerClient.createSessionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateSessionRequest,Operation>

createSessionOperationCallable()

public final OperationCallable<CreateSessionRequest,Session,SessionOperationMetadata> createSessionOperationCallable()

Create an interactive session asynchronously.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSession(Session.newBuilder().build())
           .setSessionId("sessionId607796817")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Session, SessionOperationMetadata> future =
       sessionControllerClient.createSessionOperationCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
Returns
Type Description
OperationCallable<CreateSessionRequest,Session,SessionOperationMetadata>

deleteSessionAsync(DeleteSessionRequest request)

public final OperationFuture<Session,SessionOperationMetadata> deleteSessionAsync(DeleteSessionRequest request)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   Session response = sessionControllerClient.deleteSessionAsync(request).get();
 }
Parameter
Name Description
request DeleteSessionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

deleteSessionAsync(SessionName name)

public final OperationFuture<Session,SessionOperationMetadata> deleteSessionAsync(SessionName name)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]");
   Session response = sessionControllerClient.deleteSessionAsync(name).get();
 }
Parameter
Name Description
name SessionName

Required. The name of the session resource to delete.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

deleteSessionAsync(String name)

public final OperationFuture<Session,SessionOperationMetadata> deleteSessionAsync(String name)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString();
   Session response = sessionControllerClient.deleteSessionAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the session resource to delete.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

deleteSessionCallable()

public final UnaryCallable<DeleteSessionRequest,Operation> deleteSessionCallable()

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sessionControllerClient.deleteSessionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteSessionRequest,Operation>

deleteSessionOperationCallable()

public final OperationCallable<DeleteSessionRequest,Session,SessionOperationMetadata> deleteSessionOperationCallable()

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Session, SessionOperationMetadata> future =
       sessionControllerClient.deleteSessionOperationCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteSessionRequest,Session,SessionOperationMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type Description
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = sessionControllerClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sessionControllerClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getSession(GetSessionRequest request)

public final Session getSession(GetSessionRequest request)

Gets the resource representation for an interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .build();
   Session response = sessionControllerClient.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 the resource representation for an interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]");
   Session response = sessionControllerClient.getSession(name);
 }
Parameter
Name Description
name SessionName

Required. The name of the session to retrieve.
Returns
Type Description
Session

getSession(String name)

public final Session getSession(String name)

Gets the resource representation for an interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString();
   Session response = sessionControllerClient.getSession(name);
 }
Parameter
Name Description
name String

Required. The name of the session to retrieve.
Returns
Type Description
Session

getSessionCallable()

public final UnaryCallable<GetSessionRequest,Session> getSessionCallable()

Gets the resource representation for an interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .build();
   ApiFuture<Session> future = sessionControllerClient.getSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSessionRequest,Session>

getSettings()

public final SessionControllerSettings getSettings()
Returns
Type Description
SessionControllerSettings

getStub()

public SessionControllerStub getStub()
Returns
Type Description
SessionControllerStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listSessions(ListSessionsRequest request)

public final SessionControllerClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)

Lists interactive sessions.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Session element : sessionControllerClient.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
SessionControllerClient.ListSessionsPagedResponse

listSessions(LocationName parent)

public final SessionControllerClient.ListSessionsPagedResponse listSessions(LocationName parent)

Lists interactive sessions.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Session element : sessionControllerClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The parent, which owns this collection of sessions.
Returns
Type Description
SessionControllerClient.ListSessionsPagedResponse

listSessions(String parent)

public final SessionControllerClient.ListSessionsPagedResponse listSessions(String parent)

Lists interactive sessions.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Session element : sessionControllerClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of sessions.
Returns
Type Description
SessionControllerClient.ListSessionsPagedResponse

listSessionsCallable()

public final UnaryCallable<ListSessionsRequest,ListSessionsResponse> listSessionsCallable()

Lists interactive sessions.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListSessionsResponse response =
         sessionControllerClient.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,SessionControllerClient.ListSessionsPagedResponse> listSessionsPagedCallable()

Lists interactive sessions.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Session> future =
       sessionControllerClient.listSessionsPagedCallable().futureCall(request);
   // Do something.
   for (Session element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSessionsRequest,ListSessionsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = sessionControllerClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sessionControllerClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

terminateSessionAsync(SessionName name)

public final OperationFuture<Session,SessionOperationMetadata> terminateSessionAsync(SessionName name)

Terminates the interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]");
   Session response = sessionControllerClient.terminateSessionAsync(name).get();
 }
Parameter
Name Description
name SessionName

Required. The name of the session resource to terminate.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

terminateSessionAsync(TerminateSessionRequest request)

public final OperationFuture<Session,SessionOperationMetadata> terminateSessionAsync(TerminateSessionRequest request)

Terminates the interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   TerminateSessionRequest request =
       TerminateSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   Session response = sessionControllerClient.terminateSessionAsync(request).get();
 }
Parameter
Name Description
request TerminateSessionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

terminateSessionAsync(String name)

public final OperationFuture<Session,SessionOperationMetadata> terminateSessionAsync(String name)

Terminates the interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString();
   Session response = sessionControllerClient.terminateSessionAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the session resource to terminate.
Returns
Type Description
OperationFuture<Session,SessionOperationMetadata>

terminateSessionCallable()

public final UnaryCallable<TerminateSessionRequest,Operation> terminateSessionCallable()

Terminates the interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   TerminateSessionRequest request =
       TerminateSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sessionControllerClient.terminateSessionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<TerminateSessionRequest,Operation>

terminateSessionOperationCallable()

public final OperationCallable<TerminateSessionRequest,Session,SessionOperationMetadata> terminateSessionOperationCallable()

Terminates the interactive 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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   TerminateSessionRequest request =
       TerminateSessionRequest.newBuilder()
           .setName(SessionName.of("[PROJECT]", "[LOCATION]", "[SESSION]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Session, SessionOperationMetadata> future =
       sessionControllerClient.terminateSessionOperationCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
Returns
Type Description
OperationCallable<TerminateSessionRequest,Session,SessionOperationMetadata>

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = sessionControllerClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,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 (SessionControllerClient sessionControllerClient = SessionControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       sessionControllerClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>