com.google.cloud.dataproc.v1.SessionControllerClient Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dataproc.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dataproc.v1.stub.SessionControllerStub;
import com.google.cloud.dataproc.v1.stub.SessionControllerStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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_DENIED`errors.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* setIamPolicy(SetIamPolicyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* setIamPolicyCallable()
*
*
*
*
* GetIamPolicy
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getIamPolicy(GetIamPolicyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIamPolicyCallable()
*
*
*
*
* TestIamPermissions
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.
*
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* testIamPermissions(TestIamPermissionsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* testIamPermissionsCallable()
*
*
*
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of SessionControllerSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@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
* SessionControllerSettings sessionControllerSettings =
* SessionControllerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SessionControllerClient sessionControllerClient =
* SessionControllerClient.create(sessionControllerSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* SessionControllerSettings sessionControllerSettings =
* SessionControllerSettings.newHttpJsonBuilder().build();
* SessionControllerClient sessionControllerClient =
* SessionControllerClient.create(sessionControllerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class SessionControllerClient implements BackgroundResource {
private final SessionControllerSettings settings;
private final SessionControllerStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of SessionControllerClient with default settings. */
public static final SessionControllerClient create() throws IOException {
return create(SessionControllerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final SessionControllerClient create(SessionControllerSettings settings)
throws IOException {
return new SessionControllerClient(settings);
}
/**
* Constructs an instance of SessionControllerClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(SessionControllerSettings).
*/
public static final SessionControllerClient create(SessionControllerStub stub) {
return new SessionControllerClient(stub);
}
/**
* 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.
*/
protected SessionControllerClient(SessionControllerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SessionControllerStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected SessionControllerClient(SessionControllerStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final SessionControllerSettings getSettings() {
return settings;
}
public SessionControllerStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create an interactive session asynchronously.
*
*
Sample code:
*
*
{@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();
* }
* }
*
* @param parent Required. The parent resource where this session will be created.
* @param session Required. The interactive session to create.
* @param sessionId 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][0-9]-/.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createSessionAsync(
LocationName parent, Session session, String sessionId) {
CreateSessionRequest request =
CreateSessionRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setSession(session)
.setSessionId(sessionId)
.build();
return createSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create an interactive session asynchronously.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param parent Required. The parent resource where this session will be created.
* @param session Required. The interactive session to create.
* @param sessionId 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][0-9]-/.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createSessionAsync(
String parent, Session session, String sessionId) {
CreateSessionRequest request =
CreateSessionRequest.newBuilder()
.setParent(parent)
.setSession(session)
.setSessionId(sessionId)
.build();
return createSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create an interactive session asynchronously.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createSessionAsync(
CreateSessionRequest request) {
return createSessionOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create an interactive session asynchronously.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.createSessionOperationCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final OperationCallable
createSessionOperationCallable() {
return stub.createSessionOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create an interactive session asynchronously.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.createSessionCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createSessionCallable() {
return stub.createSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the resource representation for an interactive session.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(SessionName name) {
GetSessionRequest request =
GetSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the resource representation for an interactive session.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(String name) {
GetSessionRequest request = GetSessionRequest.newBuilder().setName(name).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the resource representation for an interactive session.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(GetSessionRequest request) {
return getSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the resource representation for an interactive session.
*
* Sample code:
*
*
{@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 future = sessionControllerClient.getSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable getSessionCallable() {
return stub.getSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists interactive sessions.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(LocationName parent) {
ListSessionsRequest request =
ListSessionsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists interactive sessions.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(String parent) {
ListSessionsRequest request = ListSessionsRequest.newBuilder().setParent(parent).build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists interactive sessions.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(ListSessionsRequest request) {
return listSessionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists interactive sessions.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.listSessionsPagedCallable().futureCall(request);
* // Do something.
* for (Session element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listSessionsPagedCallable() {
return stub.listSessionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists interactive sessions.
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable listSessionsCallable() {
return stub.listSessionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Terminates the interactive session.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param name Required. The name of the session resource to terminate.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture terminateSessionAsync(
SessionName name) {
TerminateSessionRequest request =
TerminateSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return terminateSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Terminates the interactive session.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param name Required. The name of the session resource to terminate.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture terminateSessionAsync(
String name) {
TerminateSessionRequest request = TerminateSessionRequest.newBuilder().setName(name).build();
return terminateSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Terminates the interactive session.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture terminateSessionAsync(
TerminateSessionRequest request) {
return terminateSessionOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Terminates the interactive session.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.terminateSessionOperationCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final OperationCallable
terminateSessionOperationCallable() {
return stub.terminateSessionOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Terminates the interactive session.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.terminateSessionCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable terminateSessionCallable() {
return stub.terminateSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the interactive session resource. If the session is not in terminal state, it is
* terminated, and then deleted.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param name Required. The name of the session resource to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteSessionAsync(
SessionName name) {
DeleteSessionRequest request =
DeleteSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the interactive session resource. If the session is not in terminal state, it is
* terminated, and then deleted.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param name Required. The name of the session resource to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteSessionAsync(String name) {
DeleteSessionRequest request = DeleteSessionRequest.newBuilder().setName(name).build();
return deleteSessionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the interactive session resource. If the session is not in terminal state, it is
* terminated, and then deleted.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteSessionAsync(
DeleteSessionRequest request) {
return deleteSessionOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the interactive session resource. If the session is not in terminal state, it is
* terminated, and then deleted.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.deleteSessionOperationCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final OperationCallable
deleteSessionOperationCallable() {
return stub.deleteSessionOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the interactive session resource. If the session is not in terminal state, it is
* terminated, and then deleted.
*
* Sample code:
*
*
{@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 future =
* sessionControllerClient.deleteSessionCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable deleteSessionCallable() {
return stub.deleteSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
*
Sample code:
*
*
{@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 future = sessionControllerClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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 future = sessionControllerClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* TestIamPermissionsResponse response = sessionControllerClient.testIamPermissions(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* ApiFuture future =
* sessionControllerClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListSessionsPagedResponse
extends AbstractPagedListResponse<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSessionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListSessionsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListSessionsPagedResponse(ListSessionsPage page) {
super(page, ListSessionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSessionsPage
extends AbstractPage {
private ListSessionsPage(
PageContext context,
ListSessionsResponse response) {
super(context, response);
}
private static ListSessionsPage createEmptyPage() {
return new ListSessionsPage(null, null);
}
@Override
protected ListSessionsPage createPage(
PageContext context,
ListSessionsResponse response) {
return new ListSessionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSessionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
private ListSessionsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSessionsFixedSizeCollection createEmptyCollection() {
return new ListSessionsFixedSizeCollection(null, 0);
}
@Override
protected ListSessionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSessionsFixedSizeCollection(pages, collectionSize);
}
}
}