com.google.cloud.shell.v1.CloudShellServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-shell Show documentation
/*
* 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.shell.v1;
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.rpc.OperationCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.shell.v1.stub.CloudShellServiceStub;
import com.google.cloud.shell.v1.stub.CloudShellServiceStubSettings;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: API for interacting with Google Cloud Shell. Each user of Cloud Shell has at
* least one environment, which has the ID "default". Environment consists of a Docker image
* defining what is installed on the environment and a home directory containing the user's data
* that will remain across sessions. Clients use this API to start and fetch information about their
* environment, which can then be used to connect to that environment via a separate SSH client.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* EnvironmentName name = EnvironmentName.of("[USER]", "[ENVIRONMENT]");
* Environment response = cloudShellServiceClient.getEnvironment(name);
* }
* }
*
* Note: close() needs to be called on the CloudShellServiceClient 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
*
*
* GetEnvironment
Gets an environment. Returns NOT_FOUND if the environment does not exist.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getEnvironment(GetEnvironmentRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getEnvironment(EnvironmentName name)
*
getEnvironment(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.
*
* getEnvironmentCallable()
*
*
*
*
* StartEnvironment
Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* startEnvironmentAsync(StartEnvironmentRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* startEnvironmentOperationCallable()
*
startEnvironmentCallable()
*
*
*
*
* AuthorizeEnvironment
Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* authorizeEnvironmentAsync(AuthorizeEnvironmentRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* authorizeEnvironmentOperationCallable()
*
authorizeEnvironmentCallable()
*
*
*
*
* AddPublicKey
Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* addPublicKeyAsync(AddPublicKeyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* addPublicKeyOperationCallable()
*
addPublicKeyCallable()
*
*
*
*
* RemovePublicKey
Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* removePublicKeyAsync(RemovePublicKeyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* removePublicKeyOperationCallable()
*
removePublicKeyCallable()
*
*
*
*
*
* 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 CloudShellServiceSettings 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
* CloudShellServiceSettings cloudShellServiceSettings =
* CloudShellServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* CloudShellServiceClient cloudShellServiceClient =
* CloudShellServiceClient.create(cloudShellServiceSettings);
* }
*
* 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
* CloudShellServiceSettings cloudShellServiceSettings =
* CloudShellServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* CloudShellServiceClient cloudShellServiceClient =
* CloudShellServiceClient.create(cloudShellServiceSettings);
* }
*
* 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
* CloudShellServiceSettings cloudShellServiceSettings =
* CloudShellServiceSettings.newHttpJsonBuilder().build();
* CloudShellServiceClient cloudShellServiceClient =
* CloudShellServiceClient.create(cloudShellServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class CloudShellServiceClient implements BackgroundResource {
private final CloudShellServiceSettings settings;
private final CloudShellServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of CloudShellServiceClient with default settings. */
public static final CloudShellServiceClient create() throws IOException {
return create(CloudShellServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of CloudShellServiceClient, 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 CloudShellServiceClient create(CloudShellServiceSettings settings)
throws IOException {
return new CloudShellServiceClient(settings);
}
/**
* Constructs an instance of CloudShellServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(CloudShellServiceSettings).
*/
public static final CloudShellServiceClient create(CloudShellServiceStub stub) {
return new CloudShellServiceClient(stub);
}
/**
* Constructs an instance of CloudShellServiceClient, 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 CloudShellServiceClient(CloudShellServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((CloudShellServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected CloudShellServiceClient(CloudShellServiceStub 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 CloudShellServiceSettings getSettings() {
return settings;
}
public CloudShellServiceStub 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.
/**
* Gets an environment. Returns NOT_FOUND if the environment does not exist.
*
*
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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* EnvironmentName name = EnvironmentName.of("[USER]", "[ENVIRONMENT]");
* Environment response = cloudShellServiceClient.getEnvironment(name);
* }
* }
*
* @param name Required. Name of the requested resource, for example
* `users/me/environments/default` or
* `users/someone{@literal @}example.com/environments/default`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Environment getEnvironment(EnvironmentName name) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getEnvironment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an environment. Returns NOT_FOUND if the environment does not exist.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* String name = EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString();
* Environment response = cloudShellServiceClient.getEnvironment(name);
* }
* }
*
* @param name Required. Name of the requested resource, for example
* `users/me/environments/default` or
* `users/someone{@literal @}example.com/environments/default`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Environment getEnvironment(String name) {
GetEnvironmentRequest request = GetEnvironmentRequest.newBuilder().setName(name).build();
return getEnvironment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an environment. Returns NOT_FOUND if the environment does not exist.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* GetEnvironmentRequest request =
* GetEnvironmentRequest.newBuilder()
* .setName(EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString())
* .build();
* Environment response = cloudShellServiceClient.getEnvironment(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 Environment getEnvironment(GetEnvironmentRequest request) {
return getEnvironmentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an environment. Returns NOT_FOUND if the environment does not exist.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* GetEnvironmentRequest request =
* GetEnvironmentRequest.newBuilder()
* .setName(EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString())
* .build();
* ApiFuture future =
* cloudShellServiceClient.getEnvironmentCallable().futureCall(request);
* // Do something.
* Environment response = future.get();
* }
* }
*/
public final UnaryCallable getEnvironmentCallable() {
return stub.getEnvironmentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts an existing environment, allowing clients to connect to it. The returned operation will
* contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the
* environment to start by polling this operation via GetOperation. Once the environment has
* finished starting and is ready to accept connections, the operation will contain a
* StartEnvironmentResponse in its response field.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* StartEnvironmentRequest request =
* StartEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .addAllPublicKeys(new ArrayList())
* .build();
* StartEnvironmentResponse response =
* cloudShellServiceClient.startEnvironmentAsync(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
startEnvironmentAsync(StartEnvironmentRequest request) {
return startEnvironmentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts an existing environment, allowing clients to connect to it. The returned operation will
* contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the
* environment to start by polling this operation via GetOperation. Once the environment has
* finished starting and is ready to accept connections, the operation will contain a
* StartEnvironmentResponse in its response field.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* StartEnvironmentRequest request =
* StartEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .addAllPublicKeys(new ArrayList())
* .build();
* OperationFuture future =
* cloudShellServiceClient.startEnvironmentOperationCallable().futureCall(request);
* // Do something.
* StartEnvironmentResponse response = future.get();
* }
* }
*/
public final OperationCallable<
StartEnvironmentRequest, StartEnvironmentResponse, StartEnvironmentMetadata>
startEnvironmentOperationCallable() {
return stub.startEnvironmentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts an existing environment, allowing clients to connect to it. The returned operation will
* contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the
* environment to start by polling this operation via GetOperation. Once the environment has
* finished starting and is ready to accept connections, the operation will contain a
* StartEnvironmentResponse in its response field.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* StartEnvironmentRequest request =
* StartEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .addAllPublicKeys(new ArrayList())
* .build();
* ApiFuture future =
* cloudShellServiceClient.startEnvironmentCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable startEnvironmentCallable() {
return stub.startEnvironmentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends OAuth credentials to a running environment on behalf of a user. When this completes, the
* environment will be authorized to run various Google Cloud command line tools without requiring
* the user to manually authenticate.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AuthorizeEnvironmentRequest request =
* AuthorizeEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .setIdToken("idToken1642509726")
* .setExpireTime(Timestamp.newBuilder().build())
* .build();
* AuthorizeEnvironmentResponse response =
* cloudShellServiceClient.authorizeEnvironmentAsync(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
authorizeEnvironmentAsync(AuthorizeEnvironmentRequest request) {
return authorizeEnvironmentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends OAuth credentials to a running environment on behalf of a user. When this completes, the
* environment will be authorized to run various Google Cloud command line tools without requiring
* the user to manually authenticate.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AuthorizeEnvironmentRequest request =
* AuthorizeEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .setIdToken("idToken1642509726")
* .setExpireTime(Timestamp.newBuilder().build())
* .build();
* OperationFuture future =
* cloudShellServiceClient.authorizeEnvironmentOperationCallable().futureCall(request);
* // Do something.
* AuthorizeEnvironmentResponse response = future.get();
* }
* }
*/
public final OperationCallable<
AuthorizeEnvironmentRequest, AuthorizeEnvironmentResponse, AuthorizeEnvironmentMetadata>
authorizeEnvironmentOperationCallable() {
return stub.authorizeEnvironmentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends OAuth credentials to a running environment on behalf of a user. When this completes, the
* environment will be authorized to run various Google Cloud command line tools without requiring
* the user to manually authenticate.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AuthorizeEnvironmentRequest request =
* AuthorizeEnvironmentRequest.newBuilder()
* .setName("name3373707")
* .setAccessToken("accessToken-1042689291")
* .setIdToken("idToken1642509726")
* .setExpireTime(Timestamp.newBuilder().build())
* .build();
* ApiFuture future =
* cloudShellServiceClient.authorizeEnvironmentCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
authorizeEnvironmentCallable() {
return stub.authorizeEnvironmentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a public SSH key to an environment, allowing clients with the corresponding private key to
* connect to that environment via SSH. If a key with the same content already exists, this will
* error with ALREADY_EXISTS.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AddPublicKeyRequest request =
* AddPublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* AddPublicKeyResponse response = cloudShellServiceClient.addPublicKeyAsync(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 addPublicKeyAsync(
AddPublicKeyRequest request) {
return addPublicKeyOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a public SSH key to an environment, allowing clients with the corresponding private key to
* connect to that environment via SSH. If a key with the same content already exists, this will
* error with ALREADY_EXISTS.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AddPublicKeyRequest request =
* AddPublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* OperationFuture future =
* cloudShellServiceClient.addPublicKeyOperationCallable().futureCall(request);
* // Do something.
* AddPublicKeyResponse response = future.get();
* }
* }
*/
public final OperationCallable
addPublicKeyOperationCallable() {
return stub.addPublicKeyOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a public SSH key to an environment, allowing clients with the corresponding private key to
* connect to that environment via SSH. If a key with the same content already exists, this will
* error with ALREADY_EXISTS.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* AddPublicKeyRequest request =
* AddPublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* ApiFuture future =
* cloudShellServiceClient.addPublicKeyCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable addPublicKeyCallable() {
return stub.addPublicKeyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a public SSH key from an environment. Clients will no longer be able to connect to the
* environment using the corresponding private key. If a key with the same content is not present,
* this will error with NOT_FOUND.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* RemovePublicKeyRequest request =
* RemovePublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* RemovePublicKeyResponse response =
* cloudShellServiceClient.removePublicKeyAsync(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
removePublicKeyAsync(RemovePublicKeyRequest request) {
return removePublicKeyOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a public SSH key from an environment. Clients will no longer be able to connect to the
* environment using the corresponding private key. If a key with the same content is not present,
* this will error with NOT_FOUND.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* RemovePublicKeyRequest request =
* RemovePublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* OperationFuture future =
* cloudShellServiceClient.removePublicKeyOperationCallable().futureCall(request);
* // Do something.
* RemovePublicKeyResponse response = future.get();
* }
* }
*/
public final OperationCallable<
RemovePublicKeyRequest, RemovePublicKeyResponse, RemovePublicKeyMetadata>
removePublicKeyOperationCallable() {
return stub.removePublicKeyOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a public SSH key from an environment. Clients will no longer be able to connect to the
* environment using the corresponding private key. If a key with the same content is not present,
* this will error with NOT_FOUND.
*
* 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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
* RemovePublicKeyRequest request =
* RemovePublicKeyRequest.newBuilder()
* .setEnvironment("environment-85904877")
* .setKey("key106079")
* .build();
* ApiFuture future =
* cloudShellServiceClient.removePublicKeyCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable removePublicKeyCallable() {
return stub.removePublicKeyCallable();
}
@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);
}
}