Package com.google.cloud.workstations.v1beta (0.17.0)

Message for creating a CreateWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationClusterRequest

Message for creating a CreateWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationClusterRequest

Message for creating a CreateWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationConfigRequest

Message for creating a CreateWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationConfigRequest

Message for creating a CreateWorkstation.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationRequest

Message for creating a CreateWorkstation.

Protobuf type google.cloud.workstations.v1beta.CreateWorkstationRequest

Message for deleting a workstation cluster.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationClusterRequest

Message for deleting a workstation cluster.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationClusterRequest

Message for deleting a workstation configuration.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationConfigRequest

Message for deleting a workstation configuration.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationConfigRequest

Request message for DeleteWorkstation.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationRequest

Request message for DeleteWorkstation.

Protobuf type google.cloud.workstations.v1beta.DeleteWorkstationRequest

Request message for GenerateAccessToken.

Protobuf type google.cloud.workstations.v1beta.GenerateAccessTokenRequest

Request message for GenerateAccessToken.

Protobuf type google.cloud.workstations.v1beta.GenerateAccessTokenRequest

Response message for GenerateAccessToken.

Protobuf type google.cloud.workstations.v1beta.GenerateAccessTokenResponse

Response message for GenerateAccessToken.

Protobuf type google.cloud.workstations.v1beta.GenerateAccessTokenResponse

Request message for GetWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationClusterRequest

Request message for GetWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationClusterRequest

Request message for GetWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationConfigRequest

Request message for GetWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationConfigRequest

Request message for GetWorkstation.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationRequest

Request message for GetWorkstation.

Protobuf type google.cloud.workstations.v1beta.GetWorkstationRequest

Request message for ListUsableWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationConfigsRequest

Request message for ListUsableWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationConfigsRequest

Response message for ListUsableWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse

Response message for ListUsableWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse

Request message for ListUsableWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationsRequest

Request message for ListUsableWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationsRequest

Response message for ListUsableWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationsResponse

Response message for ListUsableWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListUsableWorkstationsResponse

Request message for ListWorkstationClusters.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationClustersRequest

Request message for ListWorkstationClusters.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationClustersRequest

Response message for ListWorkstationClusters.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationClustersResponse

Response message for ListWorkstationClusters.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationClustersResponse

Request message for ListWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationConfigsRequest

Request message for ListWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationConfigsRequest

Response message for ListWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationConfigsResponse

Response message for ListWorkstationConfigs.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationConfigsResponse

Request message for ListWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationsRequest

Request message for ListWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationsRequest

Response message for ListWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationsResponse

Response message for ListWorkstations.

Protobuf type google.cloud.workstations.v1beta.ListWorkstationsResponse

Builder for projects/{project}/locations/{location}.

Metadata for long-running operations.

Protobuf type google.cloud.workstations.v1beta.OperationMetadata

Metadata for long-running operations.

Protobuf type google.cloud.workstations.v1beta.OperationMetadata

Request message for StartWorkstation.

Protobuf type google.cloud.workstations.v1beta.StartWorkstationRequest

Request message for StartWorkstation.

Protobuf type google.cloud.workstations.v1beta.StartWorkstationRequest

Request message for StopWorkstation.

Protobuf type google.cloud.workstations.v1beta.StopWorkstationRequest

Request message for StopWorkstation.

Protobuf type google.cloud.workstations.v1beta.StopWorkstationRequest

Request message for UpdateWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationClusterRequest

Request message for UpdateWorkstationCluster.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationClusterRequest

Request message for UpdateWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationConfigRequest

Request message for UpdateWorkstationConfig.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationConfigRequest

Request message for UpdateWorkstation.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationRequest

Request message for UpdateWorkstation.

Protobuf type google.cloud.workstations.v1beta.UpdateWorkstationRequest

A single instance of a developer workstation with its own persistent storage.

Protobuf type google.cloud.workstations.v1beta.Workstation

A single instance of a developer workstation with its own persistent storage.

Protobuf type google.cloud.workstations.v1beta.Workstation

A workstation cluster resource in the Cloud Workstations API.

Defines a group of workstations in a particular region and the VPC network they're attached to.

Protobuf type google.cloud.workstations.v1beta.WorkstationCluster

A workstation cluster resource in the Cloud Workstations API.

Defines a group of workstations in a particular region and the VPC network they're attached to.

Protobuf type google.cloud.workstations.v1beta.WorkstationCluster

Configuration options for private workstation clusters.

Protobuf type google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig

Configuration options for private workstation clusters.

Protobuf type google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig

Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

A workstation configuration resource in the Cloud Workstations API.

Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig

A workstation configuration resource in the Cloud Workstations API.

Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig

A Docker container.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Container

A Docker container.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Container

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey

An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory

An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory

An EphemeralDirectory is backed by a Compute Engine persistent disk.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.GcePersistentDisk

An EphemeralDirectory is backed by a Compute Engine persistent disk.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.GcePersistentDisk

Runtime host for a workstation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host

Runtime host for a workstation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host

A runtime using a Compute Engine instance.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance

An accelerator card attached to the instance.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator

An accelerator card attached to the instance.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator

A runtime using a Compute Engine instance.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance

A set of Compute Engine Confidential VM instance options.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig

A set of Compute Engine Confidential VM instance options.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig

A set of Compute Engine Shielded instance options.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig

A set of Compute Engine Shielded instance options.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig

A directory to persist across workstation sessions.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory

A directory to persist across workstation sessions.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory

A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a persistent disk that mounts to the workstation VM at /home when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk

A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a persistent disk that mounts to the workstation VM at /home when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk

A readiness check to be performed on a workstation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck

A readiness check to be performed on a workstation.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck

Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}.

Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}.

Service Description: Service for interacting with Cloud Workstations.

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 (WorkstationsClient workstationsClient = WorkstationsClient.create()) {
   WorkstationClusterName name =
       WorkstationClusterName.of("[PROJECT]", "[LOCATION]", "[WORKSTATION_CLUSTER]");
   WorkstationCluster response = workstationsClient.getWorkstationCluster(name);
 }
 

Note: close() needs to be called on the WorkstationsClient 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:

1. 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.
2. 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.
3. 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 WorkstationsSettings 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
 WorkstationsSettings workstationsSettings =
     WorkstationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkstationsClient workstationsClient = WorkstationsClient.create(workstationsSettings);
 

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
 WorkstationsSettings workstationsSettings =
     WorkstationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkstationsClient workstationsClient = WorkstationsClient.create(workstationsSettings);
 

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
 WorkstationsSettings workstationsSettings = WorkstationsSettings.newHttpJsonBuilder().build();
 WorkstationsClient workstationsClient = WorkstationsClient.create(workstationsSettings);
 

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

Service for interacting with Cloud Workstations.

A stub to allow clients to do synchronous rpc calls to service Workstations.

Service for interacting with Cloud Workstations.

A stub to allow clients to do ListenableFuture-style rpc calls to service Workstations.

Service for interacting with Cloud Workstations.

Base class for the server implementation of the service Workstations.

Service for interacting with Cloud Workstations.

A stub to allow clients to do asynchronous rpc calls to service Workstations.

Service for interacting with Cloud Workstations.

Settings class to configure an instance of WorkstationsClient.

The default instance has everything set to sensible defaults:

• The default service address (workstations.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getWorkstationCluster to 30 seconds:

 // 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
 WorkstationsSettings.Builder workstationsSettingsBuilder = WorkstationsSettings.newBuilder();
 workstationsSettingsBuilder
     .getWorkstationClusterSettings()
     .setRetrySettings(
         workstationsSettingsBuilder
             .getWorkstationClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WorkstationsSettings workstationsSettings = workstationsSettingsBuilder.build();
 

Builder for WorkstationsSettings.

Service for interacting with Cloud Workstations.

Whether a workstation is running and ready to receive user requests.

Protobuf enum google.cloud.workstations.v1beta.Workstation.State

Value representing what should happen to the disk after the workstation is deleted.

Protobuf enum google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.ReclaimPolicy