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

GitHub Repository RPC Documentation REST Documentation

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.workstations.v1 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution.

Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.workstations.v1beta.WorkstationsClient 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:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.workstations.v1beta.WorkstationsSettings Settings class to configure an instance of WorkstationsClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.workstations.v1beta.CreateWorkstationClusterRequest Message for creating a CreateWorkstationCluster.
com.google.cloud.workstations.v1beta.CreateWorkstationClusterRequest.Builder Message for creating a CreateWorkstationCluster.
com.google.cloud.workstations.v1beta.CreateWorkstationConfigRequest Message for creating a CreateWorkstationConfig.
com.google.cloud.workstations.v1beta.CreateWorkstationConfigRequest.Builder Message for creating a CreateWorkstationConfig.
com.google.cloud.workstations.v1beta.CreateWorkstationRequest Message for creating a CreateWorkstation.
com.google.cloud.workstations.v1beta.CreateWorkstationRequest.Builder Message for creating a CreateWorkstation.
com.google.cloud.workstations.v1beta.DeleteWorkstationClusterRequest Message for deleting a workstation cluster.
com.google.cloud.workstations.v1beta.DeleteWorkstationClusterRequest.Builder Message for deleting a workstation cluster.
com.google.cloud.workstations.v1beta.DeleteWorkstationConfigRequest Message for deleting a workstation configuration.
com.google.cloud.workstations.v1beta.DeleteWorkstationConfigRequest.Builder Message for deleting a workstation configuration.
com.google.cloud.workstations.v1beta.DeleteWorkstationRequest Request message for DeleteWorkstation.
com.google.cloud.workstations.v1beta.DeleteWorkstationRequest.Builder Request message for DeleteWorkstation.
com.google.cloud.workstations.v1beta.GenerateAccessTokenRequest Request message for GenerateAccessToken.
com.google.cloud.workstations.v1beta.GenerateAccessTokenRequest.Builder Request message for GenerateAccessToken.
com.google.cloud.workstations.v1beta.GenerateAccessTokenResponse Response message for GenerateAccessToken.
com.google.cloud.workstations.v1beta.GenerateAccessTokenResponse.Builder Response message for GenerateAccessToken.
com.google.cloud.workstations.v1beta.GetWorkstationClusterRequest Request message for GetWorkstationCluster.
com.google.cloud.workstations.v1beta.GetWorkstationClusterRequest.Builder Request message for GetWorkstationCluster.
com.google.cloud.workstations.v1beta.GetWorkstationConfigRequest Request message for GetWorkstationConfig.
com.google.cloud.workstations.v1beta.GetWorkstationConfigRequest.Builder Request message for GetWorkstationConfig.
com.google.cloud.workstations.v1beta.GetWorkstationRequest Request message for GetWorkstation.
com.google.cloud.workstations.v1beta.GetWorkstationRequest.Builder Request message for GetWorkstation.
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsRequest Request message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsRequest.Builder Request message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse Response message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse.Builder Response message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListUsableWorkstationsRequest Request message for ListUsableWorkstations.
com.google.cloud.workstations.v1beta.ListUsableWorkstationsRequest.Builder Request message for ListUsableWorkstations.
com.google.cloud.workstations.v1beta.ListUsableWorkstationsResponse Response message for ListUsableWorkstations.
com.google.cloud.workstations.v1beta.ListUsableWorkstationsResponse.Builder Response message for ListUsableWorkstations.
com.google.cloud.workstations.v1beta.ListWorkstationClustersRequest Request message for ListWorkstationClusters.
com.google.cloud.workstations.v1beta.ListWorkstationClustersRequest.Builder Request message for ListWorkstationClusters.
com.google.cloud.workstations.v1beta.ListWorkstationClustersResponse Response message for ListWorkstationClusters.
com.google.cloud.workstations.v1beta.ListWorkstationClustersResponse.Builder Response message for ListWorkstationClusters.
com.google.cloud.workstations.v1beta.ListWorkstationConfigsRequest Request message for ListWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListWorkstationConfigsRequest.Builder Request message for ListWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListWorkstationConfigsResponse Response message for ListWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListWorkstationConfigsResponse.Builder Response message for ListWorkstationConfigs.
com.google.cloud.workstations.v1beta.ListWorkstationsRequest Request message for ListWorkstations.
com.google.cloud.workstations.v1beta.ListWorkstationsRequest.Builder Request message for ListWorkstations.
com.google.cloud.workstations.v1beta.ListWorkstationsResponse Response message for ListWorkstations.
com.google.cloud.workstations.v1beta.ListWorkstationsResponse.Builder Response message for ListWorkstations.
com.google.cloud.workstations.v1beta.LocationName
com.google.cloud.workstations.v1beta.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.workstations.v1beta.OperationMetadata Metadata for long-running operations.
com.google.cloud.workstations.v1beta.OperationMetadata.Builder Metadata for long-running operations.
com.google.cloud.workstations.v1beta.StartWorkstationRequest Request message for StartWorkstation.
com.google.cloud.workstations.v1beta.StartWorkstationRequest.Builder Request message for StartWorkstation.
com.google.cloud.workstations.v1beta.StopWorkstationRequest Request message for StopWorkstation.
com.google.cloud.workstations.v1beta.StopWorkstationRequest.Builder Request message for StopWorkstation.
com.google.cloud.workstations.v1beta.UpdateWorkstationClusterRequest Request message for UpdateWorkstationCluster.
com.google.cloud.workstations.v1beta.UpdateWorkstationClusterRequest.Builder Request message for UpdateWorkstationCluster.
com.google.cloud.workstations.v1beta.UpdateWorkstationConfigRequest Request message for UpdateWorkstationConfig.
com.google.cloud.workstations.v1beta.UpdateWorkstationConfigRequest.Builder Request message for UpdateWorkstationConfig.
com.google.cloud.workstations.v1beta.UpdateWorkstationRequest Request message for UpdateWorkstation.
com.google.cloud.workstations.v1beta.UpdateWorkstationRequest.Builder Request message for UpdateWorkstation.
com.google.cloud.workstations.v1beta.Workstation A single instance of a developer workstation with its own persistent storage.
com.google.cloud.workstations.v1beta.Workstation.Builder A single instance of a developer workstation with its own persistent storage.
com.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
com.google.cloud.workstations.v1beta.WorkstationCluster.Builder A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the
com.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig Configuration options for private workstation clusters.
com.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig.Builder Configuration options for private workstation clusters.
com.google.cloud.workstations.v1beta.WorkstationClusterName
com.google.cloud.workstations.v1beta.WorkstationClusterName.Builder Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.
com.google.cloud.workstations.v1beta.WorkstationConfig A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation
com.google.cloud.workstations.v1beta.WorkstationConfig.Builder A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation
com.google.cloud.workstations.v1beta.WorkstationConfig.Container A Docker container.
com.google.cloud.workstations.v1beta.WorkstationConfig.Container.Builder A Docker container.
com.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.
com.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey.Builder 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.
com.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.
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.Builder An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.GcePersistentDisk An EphemeralDirectory is backed by a Compute Engine persistent disk.
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.GcePersistentDisk.Builder An EphemeralDirectory is backed by a Compute Engine persistent disk.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host Runtime host for a workstation.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.Builder Runtime host for a workstation.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance A runtime using a Compute Engine instance.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator An accelerator card attached to the instance.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator.Builder An accelerator card attached to the instance.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Builder A runtime using a Compute Engine instance.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig A set of Compute Engine Confidential VM instance options.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder A set of Compute Engine Confidential VM instance options.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig A set of Compute Engine Shielded instance options.
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder A set of Compute Engine Shielded instance options.
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory A directory to persist across workstation sessions.
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.Builder A directory to persist across workstation sessions.
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.Builder A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories
com.google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck A readiness check to be performed on a workstation.
com.google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck.Builder A readiness check to be performed on a workstation.
com.google.cloud.workstations.v1beta.WorkstationConfigName
com.google.cloud.workstations.v1beta.WorkstationConfigName.Builder Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}.
com.google.cloud.workstations.v1beta.WorkstationName
com.google.cloud.workstations.v1beta.WorkstationName.Builder Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}.
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationConfigsFixedSizeCollection
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationConfigsPage
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationConfigsPagedResponse
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationsFixedSizeCollection
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationsPage
com.google.cloud.workstations.v1beta.WorkstationsClient.ListUsableWorkstationsPagedResponse
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationClustersFixedSizeCollection
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationClustersPage
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationClustersPagedResponse
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationConfigsFixedSizeCollection
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationConfigsPage
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationConfigsPagedResponse
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationsFixedSizeCollection
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationsPage
com.google.cloud.workstations.v1beta.WorkstationsClient.ListWorkstationsPagedResponse
com.google.cloud.workstations.v1beta.WorkstationsGrpc Service for interacting with Cloud Workstations.
com.google.cloud.workstations.v1beta.WorkstationsGrpc.WorkstationsImplBase Base class for the server implementation of the service Workstations. Service for interacting with Cloud Workstations.
com.google.cloud.workstations.v1beta.WorkstationsProto
com.google.cloud.workstations.v1beta.WorkstationsSettings.Builder Builder for WorkstationsSettings.

Interfaces

Interface Description
com.google.cloud.workstations.v1beta.CreateWorkstationClusterRequestOrBuilder
com.google.cloud.workstations.v1beta.CreateWorkstationConfigRequestOrBuilder
com.google.cloud.workstations.v1beta.CreateWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.DeleteWorkstationClusterRequestOrBuilder
com.google.cloud.workstations.v1beta.DeleteWorkstationConfigRequestOrBuilder
com.google.cloud.workstations.v1beta.DeleteWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.GenerateAccessTokenRequestOrBuilder
com.google.cloud.workstations.v1beta.GenerateAccessTokenResponseOrBuilder
com.google.cloud.workstations.v1beta.GetWorkstationClusterRequestOrBuilder
com.google.cloud.workstations.v1beta.GetWorkstationConfigRequestOrBuilder
com.google.cloud.workstations.v1beta.GetWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsRequestOrBuilder
com.google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponseOrBuilder
com.google.cloud.workstations.v1beta.ListUsableWorkstationsRequestOrBuilder
com.google.cloud.workstations.v1beta.ListUsableWorkstationsResponseOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationClustersRequestOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationClustersResponseOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationConfigsRequestOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationConfigsResponseOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationsRequestOrBuilder
com.google.cloud.workstations.v1beta.ListWorkstationsResponseOrBuilder
com.google.cloud.workstations.v1beta.OperationMetadataOrBuilder
com.google.cloud.workstations.v1beta.StartWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.StopWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.UpdateWorkstationClusterRequestOrBuilder
com.google.cloud.workstations.v1beta.UpdateWorkstationConfigRequestOrBuilder
com.google.cloud.workstations.v1beta.UpdateWorkstationRequestOrBuilder
com.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfigOrBuilder
com.google.cloud.workstations.v1beta.WorkstationClusterOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.ContainerOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKeyOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.GcePersistentDiskOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectoryOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfigOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfigOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstanceOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.HostOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDiskOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectoryOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheckOrBuilder
com.google.cloud.workstations.v1beta.WorkstationConfigOrBuilder
com.google.cloud.workstations.v1beta.WorkstationOrBuilder
com.google.cloud.workstations.v1beta.WorkstationsGrpc.AsyncService Service for interacting with Cloud Workstations.

Enums

Enum Description
com.google.cloud.workstations.v1beta.GenerateAccessTokenRequest.ExpirationCase
com.google.cloud.workstations.v1beta.Workstation.State Whether a workstation is running and ready to receive user requests.
com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory.DirectoryTypeCase
com.google.cloud.workstations.v1beta.WorkstationConfig.Host.ConfigCase
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.DirectoryTypeCase
com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.ReclaimPolicy Value representing what should happen to the disk after the workstation is deleted.