CloudShellServiceClient (Google Cloud Shell 2.32.0 API)

java.lang.Object
- com.google.cloud.shell.v1.CloudShellServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class CloudShellServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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:


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

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:


 // 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:


 // 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:


 // 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.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CloudShellServiceClient(CloudShellServiceSettings settings)` Constructs an instance of CloudShellServiceClient, using the given settings.
`protected`	`CloudShellServiceClient(CloudShellServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.gax.longrunning.OperationFuture<AddPublicKeyResponse,AddPublicKeyMetadata>`	`addPublicKeyAsync(AddPublicKeyRequest request)` Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.
`com.google.api.gax.rpc.UnaryCallable<AddPublicKeyRequest,com.google.longrunning.Operation>`	`addPublicKeyCallable()` Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.
`com.google.api.gax.rpc.OperationCallable<AddPublicKeyRequest,AddPublicKeyResponse,AddPublicKeyMetadata>`	`addPublicKeyOperationCallable()` Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.
`com.google.api.gax.longrunning.OperationFuture<AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata>`	`authorizeEnvironmentAsync(AuthorizeEnvironmentRequest request)` Sends OAuth credentials to a running environment on behalf of a user.
`com.google.api.gax.rpc.UnaryCallable<AuthorizeEnvironmentRequest,com.google.longrunning.Operation>`	`authorizeEnvironmentCallable()` Sends OAuth credentials to a running environment on behalf of a user.
`com.google.api.gax.rpc.OperationCallable<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata>`	`authorizeEnvironmentOperationCallable()` Sends OAuth credentials to a running environment on behalf of a user.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static CloudShellServiceClient`	`create()` Constructs an instance of CloudShellServiceClient with default settings.
`static CloudShellServiceClient`	`create(CloudShellServiceSettings settings)` Constructs an instance of CloudShellServiceClient, using the given settings.
`static CloudShellServiceClient`	`create(CloudShellServiceStub stub)` Constructs an instance of CloudShellServiceClient, using the given stub for making calls.
`Environment`	`getEnvironment(EnvironmentName name)` Gets an environment.
`Environment`	`getEnvironment(GetEnvironmentRequest request)` Gets an environment.
`Environment`	`getEnvironment(String name)` Gets an environment.
`com.google.api.gax.rpc.UnaryCallable<GetEnvironmentRequest,Environment>`	`getEnvironmentCallable()` Gets an environment.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`CloudShellServiceSettings`	`getSettings()`
`CloudShellServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.gax.longrunning.OperationFuture<RemovePublicKeyResponse,RemovePublicKeyMetadata>`	`removePublicKeyAsync(RemovePublicKeyRequest request)` Removes a public SSH key from an environment.
`com.google.api.gax.rpc.UnaryCallable<RemovePublicKeyRequest,com.google.longrunning.Operation>`	`removePublicKeyCallable()` Removes a public SSH key from an environment.
`com.google.api.gax.rpc.OperationCallable<RemovePublicKeyRequest,RemovePublicKeyResponse,RemovePublicKeyMetadata>`	`removePublicKeyOperationCallable()` Removes a public SSH key from an environment.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<StartEnvironmentResponse,StartEnvironmentMetadata>`	`startEnvironmentAsync(StartEnvironmentRequest request)` Starts an existing environment, allowing clients to connect to it.
`com.google.api.gax.rpc.UnaryCallable<StartEnvironmentRequest,com.google.longrunning.Operation>`	`startEnvironmentCallable()` Starts an existing environment, allowing clients to connect to it.
`com.google.api.gax.rpc.OperationCallable<StartEnvironmentRequest,StartEnvironmentResponse,StartEnvironmentMetadata>`	`startEnvironmentOperationCallable()` Starts an existing environment, allowing clients to connect to it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CloudShellServiceClient
```
protected CloudShellServiceClient(CloudShellServiceSettings settings)
                           throws IOException
```
  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.
  
  Throws:
  
  IOException
- CloudShellServiceClient
```
protected CloudShellServiceClient(CloudShellServiceStub stub)
```

Method Detail

create

public static final CloudShellServiceClient create()
                                            throws IOException

Constructs an instance of CloudShellServiceClient with default settings.

Throws:: IOException

create
```
public static final CloudShellServiceClient create(CloudShellServiceSettings settings)
                                            throws IOException
```
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.

Throws:

IOException

create
```
public static final CloudShellServiceClient create(CloudShellServiceStub stub)
```
Constructs an instance of CloudShellServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudShellServiceSettings).

getSettings

public final CloudShellServiceSettings getSettings()

getStub

public CloudShellServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getEnvironment

public final Environment getEnvironment(EnvironmentName name)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   EnvironmentName name = EnvironmentName.of("[USER]", "[ENVIRONMENT]");
   Environment response = cloudShellServiceClient.getEnvironment(name);
 }

Parameters:: name - Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEnvironment

public final Environment getEnvironment(String name)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   String name = EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString();
   Environment response = cloudShellServiceClient.getEnvironment(name);
 }

Parameters:: name - Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEnvironment

public final Environment getEnvironment(GetEnvironmentRequest request)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString())
           .build();
   Environment response = cloudShellServiceClient.getEnvironment(request);
 }

Parameters:: 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

getEnvironmentCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(EnvironmentName.of("[USER]", "[ENVIRONMENT]").toString())
           .build();
   ApiFuture<Environment> future =
       cloudShellServiceClient.getEnvironmentCallable().futureCall(request);
   // Do something.
   Environment response = future.get();
 }

startEnvironmentAsync

public final com.google.api.gax.longrunning.OperationFuture<StartEnvironmentResponse,StartEnvironmentMetadata> startEnvironmentAsync(StartEnvironmentRequest request)

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:


 // 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<String>())
           .build();
   StartEnvironmentResponse response =
       cloudShellServiceClient.startEnvironmentAsync(request).get();
 }

Parameters:: 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

startEnvironmentOperationCallable

public final com.google.api.gax.rpc.OperationCallable<StartEnvironmentRequest,StartEnvironmentResponse,StartEnvironmentMetadata> startEnvironmentOperationCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   StartEnvironmentRequest request =
       StartEnvironmentRequest.newBuilder()
           .setName("name3373707")
           .setAccessToken("accessToken-1042689291")
           .addAllPublicKeys(new ArrayList<String>())
           .build();
   OperationFuture<StartEnvironmentResponse, StartEnvironmentMetadata> future =
       cloudShellServiceClient.startEnvironmentOperationCallable().futureCall(request);
   // Do something.
   StartEnvironmentResponse response = future.get();
 }

startEnvironmentCallable

public final com.google.api.gax.rpc.UnaryCallable<StartEnvironmentRequest,com.google.longrunning.Operation> startEnvironmentCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   StartEnvironmentRequest request =
       StartEnvironmentRequest.newBuilder()
           .setName("name3373707")
           .setAccessToken("accessToken-1042689291")
           .addAllPublicKeys(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future =
       cloudShellServiceClient.startEnvironmentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

authorizeEnvironmentAsync

public final com.google.api.gax.longrunning.OperationFuture<AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata> authorizeEnvironmentAsync(AuthorizeEnvironmentRequest request)

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:


 // 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();
 }

Parameters:: 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

authorizeEnvironmentOperationCallable

public final com.google.api.gax.rpc.OperationCallable<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata> authorizeEnvironmentOperationCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   AuthorizeEnvironmentRequest request =
       AuthorizeEnvironmentRequest.newBuilder()
           .setName("name3373707")
           .setAccessToken("accessToken-1042689291")
           .setIdToken("idToken1642509726")
           .setExpireTime(Timestamp.newBuilder().build())
           .build();
   OperationFuture<AuthorizeEnvironmentResponse, AuthorizeEnvironmentMetadata> future =
       cloudShellServiceClient.authorizeEnvironmentOperationCallable().futureCall(request);
   // Do something.
   AuthorizeEnvironmentResponse response = future.get();
 }

authorizeEnvironmentCallable

public final com.google.api.gax.rpc.UnaryCallable<AuthorizeEnvironmentRequest,com.google.longrunning.Operation> authorizeEnvironmentCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   AuthorizeEnvironmentRequest request =
       AuthorizeEnvironmentRequest.newBuilder()
           .setName("name3373707")
           .setAccessToken("accessToken-1042689291")
           .setIdToken("idToken1642509726")
           .setExpireTime(Timestamp.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       cloudShellServiceClient.authorizeEnvironmentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

addPublicKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<AddPublicKeyResponse,AddPublicKeyMetadata> addPublicKeyAsync(AddPublicKeyRequest request)

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:


 // 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();
 }

Parameters:: 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

addPublicKeyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<AddPublicKeyRequest,AddPublicKeyResponse,AddPublicKeyMetadata> addPublicKeyOperationCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   AddPublicKeyRequest request =
       AddPublicKeyRequest.newBuilder()
           .setEnvironment("environment-85904877")
           .setKey("key106079")
           .build();
   OperationFuture<AddPublicKeyResponse, AddPublicKeyMetadata> future =
       cloudShellServiceClient.addPublicKeyOperationCallable().futureCall(request);
   // Do something.
   AddPublicKeyResponse response = future.get();
 }

addPublicKeyCallable

public final com.google.api.gax.rpc.UnaryCallable<AddPublicKeyRequest,com.google.longrunning.Operation> addPublicKeyCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   AddPublicKeyRequest request =
       AddPublicKeyRequest.newBuilder()
           .setEnvironment("environment-85904877")
           .setKey("key106079")
           .build();
   ApiFuture<Operation> future =
       cloudShellServiceClient.addPublicKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

removePublicKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<RemovePublicKeyResponse,RemovePublicKeyMetadata> removePublicKeyAsync(RemovePublicKeyRequest request)

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:


 // 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();
 }

Parameters:: 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

removePublicKeyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<RemovePublicKeyRequest,RemovePublicKeyResponse,RemovePublicKeyMetadata> removePublicKeyOperationCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   RemovePublicKeyRequest request =
       RemovePublicKeyRequest.newBuilder()
           .setEnvironment("environment-85904877")
           .setKey("key106079")
           .build();
   OperationFuture<RemovePublicKeyResponse, RemovePublicKeyMetadata> future =
       cloudShellServiceClient.removePublicKeyOperationCallable().futureCall(request);
   // Do something.
   RemovePublicKeyResponse response = future.get();
 }

removePublicKeyCallable

public final com.google.api.gax.rpc.UnaryCallable<RemovePublicKeyRequest,com.google.longrunning.Operation> removePublicKeyCallable()

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 (CloudShellServiceClient cloudShellServiceClient = CloudShellServiceClient.create()) {
   RemovePublicKeyRequest request =
       RemovePublicKeyRequest.newBuilder()
           .setEnvironment("environment-85904877")
           .setKey("key106079")
           .build();
   ApiFuture<Operation> future =
       cloudShellServiceClient.removePublicKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class CloudShellServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudShellServiceClient

CloudShellServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

getEnvironment

getEnvironment

getEnvironment

getEnvironmentCallable

startEnvironmentAsync

startEnvironmentOperationCallable

startEnvironmentCallable

authorizeEnvironmentAsync

authorizeEnvironmentOperationCallable

authorizeEnvironmentCallable

addPublicKeyAsync

addPublicKeyOperationCallable

addPublicKeyCallable

removePublicKeyAsync

removePublicKeyOperationCallable

removePublicKeyCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination