Class SessionTemplateControllerClient (4.37.0)

Version 4.37.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

Service Description: The SessionTemplateController provides methods to manage session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SessionTemplate sessionTemplate = SessionTemplate.newBuilder().build();
   SessionTemplate response =
       sessionTemplateControllerClient.createSessionTemplate(parent, sessionTemplate);
 }
 

Note: close() needs to be called on the SessionTemplateControllerClient 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
CreateSessionTemplate	Create a session template synchronously.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSessionTemplate(CreateSessionTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createSessionTemplate(LocationName parent, SessionTemplate sessionTemplate) createSessionTemplate(String parent, SessionTemplate sessionTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSessionTemplateCallable()
UpdateSessionTemplate	Updates the session template synchronously.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSessionTemplate(UpdateSessionTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateSessionTemplate(SessionTemplate sessionTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateSessionTemplateCallable()
GetSessionTemplate	Gets the resource representation for a session template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSessionTemplate(GetSessionTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSessionTemplate(SessionTemplateName name) getSessionTemplate(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. getSessionTemplateCallable()
ListSessionTemplates	Lists session templates.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSessionTemplates(ListSessionTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSessionTemplates(LocationName parent) listSessionTemplates(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. listSessionTemplatesPagedCallable() listSessionTemplatesCallable()
DeleteSessionTemplate	Deletes a session template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSessionTemplate(DeleteSessionTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSessionTemplate(SessionTemplateName name) deleteSessionTemplate(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. deleteSessionTemplateCallable()
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 SessionTemplateControllerSettings 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
 SessionTemplateControllerSettings sessionTemplateControllerSettings =
     SessionTemplateControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create(sessionTemplateControllerSettings);
 

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
 SessionTemplateControllerSettings sessionTemplateControllerSettings =
     SessionTemplateControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create(sessionTemplateControllerSettings);
 

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
 SessionTemplateControllerSettings sessionTemplateControllerSettings =
     SessionTemplateControllerSettings.newHttpJsonBuilder().build();
 SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create(sessionTemplateControllerSettings);
 

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

Inheritance

java.lang.Object > SessionTemplateControllerClient

Static Methods

create()

public static final SessionTemplateControllerClient create()

Constructs an instance of SessionTemplateControllerClient with default settings.

Returns
Type	Description
SessionTemplateControllerClient

Exceptions
Type	Description
IOException

create(SessionTemplateControllerSettings settings)

public static final SessionTemplateControllerClient create(SessionTemplateControllerSettings settings)

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

Returns
Type	Description
SessionTemplateControllerClient

Exceptions
Type	Description
IOException

create(SessionTemplateControllerStub stub)

public static final SessionTemplateControllerClient create(SessionTemplateControllerStub stub)

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

Parameter
Name	Description
stub	SessionTemplateControllerStub

Returns
Type	Description
SessionTemplateControllerClient

Constructors

SessionTemplateControllerClient(SessionTemplateControllerSettings settings)

protected SessionTemplateControllerClient(SessionTemplateControllerSettings settings)

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

SessionTemplateControllerClient(SessionTemplateControllerStub stub)

protected SessionTemplateControllerClient(SessionTemplateControllerStub stub)

Parameter
Name	Description
stub	SessionTemplateControllerStub

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

createSessionTemplate(CreateSessionTemplateRequest request)

public final SessionTemplate createSessionTemplate(CreateSessionTemplateRequest request)

Create a session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   CreateSessionTemplateRequest request =
       CreateSessionTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSessionTemplate(SessionTemplate.newBuilder().build())
           .build();
   SessionTemplate response = sessionTemplateControllerClient.createSessionTemplate(request);
 }
 

Parameter
Name	Description
request	CreateSessionTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SessionTemplate

createSessionTemplate(LocationName parent, SessionTemplate sessionTemplate)

public final SessionTemplate createSessionTemplate(LocationName parent, SessionTemplate sessionTemplate)

Create a session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SessionTemplate sessionTemplate = SessionTemplate.newBuilder().build();
   SessionTemplate response =
       sessionTemplateControllerClient.createSessionTemplate(parent, sessionTemplate);
 }
 

Parameters
Name	Description
parent	LocationName Required. The parent resource where this session template will be created.
sessionTemplate	SessionTemplate Required. The session template to create.

Returns
Type	Description
SessionTemplate

createSessionTemplate(String parent, SessionTemplate sessionTemplate)

public final SessionTemplate createSessionTemplate(String parent, SessionTemplate sessionTemplate)

Create a session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SessionTemplate sessionTemplate = SessionTemplate.newBuilder().build();
   SessionTemplate response =
       sessionTemplateControllerClient.createSessionTemplate(parent, sessionTemplate);
 }
 

Parameters
Name	Description
parent	String Required. The parent resource where this session template will be created.
sessionTemplate	SessionTemplate Required. The session template to create.

Returns
Type	Description
SessionTemplate

createSessionTemplateCallable()

public final UnaryCallable<CreateSessionTemplateRequest,SessionTemplate> createSessionTemplateCallable()

Create a session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   CreateSessionTemplateRequest request =
       CreateSessionTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSessionTemplate(SessionTemplate.newBuilder().build())
           .build();
   ApiFuture<SessionTemplate> future =
       sessionTemplateControllerClient.createSessionTemplateCallable().futureCall(request);
   // Do something.
   SessionTemplate response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateSessionTemplateRequest,SessionTemplate>

deleteSessionTemplate(DeleteSessionTemplateRequest request)

public final void deleteSessionTemplate(DeleteSessionTemplateRequest request)

Deletes a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   DeleteSessionTemplateRequest request =
       DeleteSessionTemplateRequest.newBuilder()
           .setName(SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
           .build();
   sessionTemplateControllerClient.deleteSessionTemplate(request);
 }
 

Parameter
Name	Description
request	DeleteSessionTemplateRequest The request object containing all of the parameters for the API call.

deleteSessionTemplate(SessionTemplateName name)

public final void deleteSessionTemplate(SessionTemplateName name)

Deletes a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   SessionTemplateName name = SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
   sessionTemplateControllerClient.deleteSessionTemplate(name);
 }
 

Parameter
Name	Description
name	SessionTemplateName Required. The name of the session template resource to delete.

deleteSessionTemplate(String name)

public final void deleteSessionTemplate(String name)

Deletes a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   String name = SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
   sessionTemplateControllerClient.deleteSessionTemplate(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the session template resource to delete.

deleteSessionTemplateCallable()

public final UnaryCallable<DeleteSessionTemplateRequest,Empty> deleteSessionTemplateCallable()

Deletes a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   DeleteSessionTemplateRequest request =
       DeleteSessionTemplateRequest.newBuilder()
           .setName(SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
           .build();
   ApiFuture<Empty> future =
       sessionTemplateControllerClient.deleteSessionTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteSessionTemplateRequest,Empty>

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = sessionTemplateControllerClient.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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       sessionTemplateControllerClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getSessionTemplate(GetSessionTemplateRequest request)

public final SessionTemplate getSessionTemplate(GetSessionTemplateRequest request)

Gets the resource representation for a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   GetSessionTemplateRequest request =
       GetSessionTemplateRequest.newBuilder()
           .setName(SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
           .build();
   SessionTemplate response = sessionTemplateControllerClient.getSessionTemplate(request);
 }
 

Parameter
Name	Description
request	GetSessionTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SessionTemplate

getSessionTemplate(SessionTemplateName name)

public final SessionTemplate getSessionTemplate(SessionTemplateName name)

Gets the resource representation for a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   SessionTemplateName name = SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
   SessionTemplate response = sessionTemplateControllerClient.getSessionTemplate(name);
 }
 

Parameter
Name	Description
name	SessionTemplateName Required. The name of the session template to retrieve.

Returns
Type	Description
SessionTemplate

getSessionTemplate(String name)

public final SessionTemplate getSessionTemplate(String name)

Gets the resource representation for a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   String name = SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
   SessionTemplate response = sessionTemplateControllerClient.getSessionTemplate(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the session template to retrieve.

Returns
Type	Description
SessionTemplate

getSessionTemplateCallable()

public final UnaryCallable<GetSessionTemplateRequest,SessionTemplate> getSessionTemplateCallable()

Gets the resource representation for a session template.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   GetSessionTemplateRequest request =
       GetSessionTemplateRequest.newBuilder()
           .setName(SessionTemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
           .build();
   ApiFuture<SessionTemplate> future =
       sessionTemplateControllerClient.getSessionTemplateCallable().futureCall(request);
   // Do something.
   SessionTemplate response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetSessionTemplateRequest,SessionTemplate>

getSettings()

public final SessionTemplateControllerSettings getSettings()

Returns
Type	Description
SessionTemplateControllerSettings

getStub()

public SessionTemplateControllerStub getStub()

Returns
Type	Description
SessionTemplateControllerStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listSessionTemplates(ListSessionTemplatesRequest request)

public final SessionTemplateControllerClient.ListSessionTemplatesPagedResponse listSessionTemplates(ListSessionTemplatesRequest request)

Lists session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   ListSessionTemplatesRequest request =
       ListSessionTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (SessionTemplate element :
       sessionTemplateControllerClient.listSessionTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListSessionTemplatesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SessionTemplateControllerClient.ListSessionTemplatesPagedResponse

listSessionTemplates(LocationName parent)

public final SessionTemplateControllerClient.ListSessionTemplatesPagedResponse listSessionTemplates(LocationName parent)

Lists session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SessionTemplate element :
       sessionTemplateControllerClient.listSessionTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. The parent that owns this collection of session templates.

Returns
Type	Description
SessionTemplateControllerClient.ListSessionTemplatesPagedResponse

listSessionTemplates(String parent)

public final SessionTemplateControllerClient.ListSessionTemplatesPagedResponse listSessionTemplates(String parent)

Lists session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SessionTemplate element :
       sessionTemplateControllerClient.listSessionTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent that owns this collection of session templates.

Returns
Type	Description
SessionTemplateControllerClient.ListSessionTemplatesPagedResponse

listSessionTemplatesCallable()

public final UnaryCallable<ListSessionTemplatesRequest,ListSessionTemplatesResponse> listSessionTemplatesCallable()

Lists session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   ListSessionTemplatesRequest request =
       ListSessionTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListSessionTemplatesResponse response =
         sessionTemplateControllerClient.listSessionTemplatesCallable().call(request);
     for (SessionTemplate element : response.getSessionTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSessionTemplatesRequest,ListSessionTemplatesResponse>

listSessionTemplatesPagedCallable()

public final UnaryCallable<ListSessionTemplatesRequest,SessionTemplateControllerClient.ListSessionTemplatesPagedResponse> listSessionTemplatesPagedCallable()

Lists session templates.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   ListSessionTemplatesRequest request =
       ListSessionTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<SessionTemplate> future =
       sessionTemplateControllerClient.listSessionTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (SessionTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSessionTemplatesRequest,ListSessionTemplatesPagedResponse>

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = sessionTemplateControllerClient.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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.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 =
       sessionTemplateControllerClient.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()

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       sessionTemplateControllerClient.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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       sessionTemplateControllerClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateSessionTemplate(SessionTemplate sessionTemplate)

public final SessionTemplate updateSessionTemplate(SessionTemplate sessionTemplate)

Updates the session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   SessionTemplate sessionTemplate = SessionTemplate.newBuilder().build();
   SessionTemplate response =
       sessionTemplateControllerClient.updateSessionTemplate(sessionTemplate);
 }
 

Parameter
Name	Description
sessionTemplate	SessionTemplate Required. The updated session template.

Returns
Type	Description
SessionTemplate

updateSessionTemplate(UpdateSessionTemplateRequest request)

public final SessionTemplate updateSessionTemplate(UpdateSessionTemplateRequest request)

Updates the session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   UpdateSessionTemplateRequest request =
       UpdateSessionTemplateRequest.newBuilder()
           .setSessionTemplate(SessionTemplate.newBuilder().build())
           .build();
   SessionTemplate response = sessionTemplateControllerClient.updateSessionTemplate(request);
 }
 

Parameter
Name	Description
request	UpdateSessionTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SessionTemplate

updateSessionTemplateCallable()

public final UnaryCallable<UpdateSessionTemplateRequest,SessionTemplate> updateSessionTemplateCallable()

Updates the session template synchronously.

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 (SessionTemplateControllerClient sessionTemplateControllerClient =
     SessionTemplateControllerClient.create()) {
   UpdateSessionTemplateRequest request =
       UpdateSessionTemplateRequest.newBuilder()
           .setSessionTemplate(SessionTemplate.newBuilder().build())
           .build();
   ApiFuture<SessionTemplate> future =
       sessionTemplateControllerClient.updateSessionTemplateCallable().futureCall(request);
   // Do something.
   SessionTemplate response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateSessionTemplateRequest,SessionTemplate>