Class CloudShellServiceClient (2.30.0)

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Inheritance

java.lang.Object > CloudShellServiceClient

Static Methods

create()

public static final CloudShellServiceClient create()

Constructs an instance of CloudShellServiceClient with default settings.

Returns
Type	Description
`CloudShellServiceClient`

Exceptions
Type	Description
`IOException`

create(CloudShellServiceSettings settings)

public static final CloudShellServiceClient create(CloudShellServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`CloudShellServiceSettings`

Returns
Type	Description
`CloudShellServiceClient`

Exceptions
Type	Description
`IOException`

create(CloudShellServiceStub stub)

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

Parameter
Name	Description
`stub`	`CloudShellServiceStub`

Returns
Type	Description
`CloudShellServiceClient`

Constructors

CloudShellServiceClient(CloudShellServiceSettings settings)

protected CloudShellServiceClient(CloudShellServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`CloudShellServiceSettings`

CloudShellServiceClient(CloudShellServiceStub stub)

protected CloudShellServiceClient(CloudShellServiceStub stub)

Parameter
Name	Description
`stub`	`CloudShellServiceStub`

Methods

addPublicKeyAsync(AddPublicKeyRequest request)

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

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

Returns
Type	Description
`OperationFuture<AddPublicKeyResponse,AddPublicKeyMetadata>`

addPublicKeyCallable()

public final UnaryCallable<AddPublicKeyRequest,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();
 }

Returns
Type	Description
`UnaryCallable<AddPublicKeyRequest,Operation>`

addPublicKeyOperationCallable()

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

Returns
Type	Description
`OperationCallable<AddPublicKeyRequest,AddPublicKeyResponse,AddPublicKeyMetadata>`

authorizeEnvironmentAsync(AuthorizeEnvironmentRequest request)

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

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

Returns
Type	Description
`OperationFuture<AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata>`

authorizeEnvironmentCallable()

public final UnaryCallable<AuthorizeEnvironmentRequest,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();
 }

Returns
Type	Description
`UnaryCallable<AuthorizeEnvironmentRequest,Operation>`

authorizeEnvironmentOperationCallable()

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

Returns
Type	Description
`OperationCallable<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata>`

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getEnvironment(EnvironmentName name)

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

Parameter
Name	Description
`name`	`EnvironmentName` Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.

Returns
Type	Description
`Environment`

getEnvironment(GetEnvironmentRequest request)

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

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

Returns
Type	Description
`Environment`

getEnvironment(String name)

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

Parameter
Name	Description
`name`	`String` Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.

Returns
Type	Description
`Environment`

getEnvironmentCallable()

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

Returns
Type	Description
`UnaryCallable<GetEnvironmentRequest,Environment>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getSettings()

public final CloudShellServiceSettings getSettings()

Returns
Type	Description
`CloudShellServiceSettings`

getStub()

public CloudShellServiceStub getStub()

Returns
Type	Description
`CloudShellServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

removePublicKeyAsync(RemovePublicKeyRequest request)

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

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

Returns
Type	Description
`OperationFuture<RemovePublicKeyResponse,RemovePublicKeyMetadata>`

removePublicKeyCallable()

public final UnaryCallable<RemovePublicKeyRequest,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();
 }

Returns
Type	Description
`UnaryCallable<RemovePublicKeyRequest,Operation>`

removePublicKeyOperationCallable()

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

Returns
Type	Description
`OperationCallable<RemovePublicKeyRequest,RemovePublicKeyResponse,RemovePublicKeyMetadata>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startEnvironmentAsync(StartEnvironmentRequest request)

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

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

Returns
Type	Description
`OperationFuture<StartEnvironmentResponse,StartEnvironmentMetadata>`

startEnvironmentCallable()

public final UnaryCallable<StartEnvironmentRequest,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();
 }

Returns
Type	Description
`UnaryCallable<StartEnvironmentRequest,Operation>`

startEnvironmentOperationCallable()

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

Returns
Type	Description
`OperationCallable<StartEnvironmentRequest,StartEnvironmentResponse,StartEnvironmentMetadata>`