Package com.google.cloud.workstations.v1 (0.83.0)

0.83.0 (latest) 0.82.0 0.81.0 0.79.0 0.76.0 0.75.0 0.73.0 0.71.0 0.70.0 0.68.0 0.66.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.58.0 0.56.0 0.55.0 0.52.0 0.51.0 0.50.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

GitHub Repository

RPC Documentation

REST Documentation

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.v1.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.v1.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.v1.CreateWorkstationClusterRequest	Message for creating a CreateWorkstationCluster.
com.google.cloud.workstations.v1.CreateWorkstationClusterRequest.Builder	Message for creating a CreateWorkstationCluster.
com.google.cloud.workstations.v1.CreateWorkstationConfigRequest	Message for creating a CreateWorkstationConfig.
com.google.cloud.workstations.v1.CreateWorkstationConfigRequest.Builder	Message for creating a CreateWorkstationConfig.
com.google.cloud.workstations.v1.CreateWorkstationRequest	Message for creating a CreateWorkstation.
com.google.cloud.workstations.v1.CreateWorkstationRequest.Builder	Message for creating a CreateWorkstation.
com.google.cloud.workstations.v1.DeleteWorkstationClusterRequest	Message for deleting a workstation cluster.
com.google.cloud.workstations.v1.DeleteWorkstationClusterRequest.Builder	Message for deleting a workstation cluster.
com.google.cloud.workstations.v1.DeleteWorkstationConfigRequest	Message for deleting a workstation configuration.
com.google.cloud.workstations.v1.DeleteWorkstationConfigRequest.Builder	Message for deleting a workstation configuration.
com.google.cloud.workstations.v1.DeleteWorkstationRequest	Request message for DeleteWorkstation.
com.google.cloud.workstations.v1.DeleteWorkstationRequest.Builder	Request message for DeleteWorkstation.
com.google.cloud.workstations.v1.GenerateAccessTokenRequest	Request message for GenerateAccessToken.
com.google.cloud.workstations.v1.GenerateAccessTokenRequest.Builder	Request message for GenerateAccessToken.
com.google.cloud.workstations.v1.GenerateAccessTokenResponse	Response message for GenerateAccessToken.
com.google.cloud.workstations.v1.GenerateAccessTokenResponse.Builder	Response message for GenerateAccessToken.
com.google.cloud.workstations.v1.GetWorkstationClusterRequest	Request message for GetWorkstationCluster.
com.google.cloud.workstations.v1.GetWorkstationClusterRequest.Builder	Request message for GetWorkstationCluster.
com.google.cloud.workstations.v1.GetWorkstationConfigRequest	Request message for GetWorkstationConfig.
com.google.cloud.workstations.v1.GetWorkstationConfigRequest.Builder	Request message for GetWorkstationConfig.
com.google.cloud.workstations.v1.GetWorkstationRequest	Request message for GetWorkstation.
com.google.cloud.workstations.v1.GetWorkstationRequest.Builder	Request message for GetWorkstation.
com.google.cloud.workstations.v1.ListUsableWorkstationConfigsRequest	Request message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1.ListUsableWorkstationConfigsRequest.Builder	Request message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1.ListUsableWorkstationConfigsResponse	Response message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1.ListUsableWorkstationConfigsResponse.Builder	Response message for ListUsableWorkstationConfigs.
com.google.cloud.workstations.v1.ListUsableWorkstationsRequest	Request message for ListUsableWorkstations.
com.google.cloud.workstations.v1.ListUsableWorkstationsRequest.Builder	Request message for ListUsableWorkstations.
com.google.cloud.workstations.v1.ListUsableWorkstationsResponse	Response message for ListUsableWorkstations.
com.google.cloud.workstations.v1.ListUsableWorkstationsResponse.Builder	Response message for ListUsableWorkstations.
com.google.cloud.workstations.v1.ListWorkstationClustersRequest	Request message for ListWorkstationClusters.
com.google.cloud.workstations.v1.ListWorkstationClustersRequest.Builder	Request message for ListWorkstationClusters.
com.google.cloud.workstations.v1.ListWorkstationClustersResponse	Response message for ListWorkstationClusters.
com.google.cloud.workstations.v1.ListWorkstationClustersResponse.Builder	Response message for ListWorkstationClusters.
com.google.cloud.workstations.v1.ListWorkstationConfigsRequest	Request message for ListWorkstationConfigs.
com.google.cloud.workstations.v1.ListWorkstationConfigsRequest.Builder	Request message for ListWorkstationConfigs.
com.google.cloud.workstations.v1.ListWorkstationConfigsResponse	Response message for ListWorkstationConfigs.
com.google.cloud.workstations.v1.ListWorkstationConfigsResponse.Builder	Response message for ListWorkstationConfigs.
com.google.cloud.workstations.v1.ListWorkstationsRequest	Request message for ListWorkstations.
com.google.cloud.workstations.v1.ListWorkstationsRequest.Builder	Request message for ListWorkstations.
com.google.cloud.workstations.v1.ListWorkstationsResponse	Response message for ListWorkstations.
com.google.cloud.workstations.v1.ListWorkstationsResponse.Builder	Response message for ListWorkstations.
com.google.cloud.workstations.v1.LocationName
com.google.cloud.workstations.v1.LocationName.Builder	Builder for projects/{project}/locations/{location}.
com.google.cloud.workstations.v1.OperationMetadata	Metadata for long-running operations.
com.google.cloud.workstations.v1.OperationMetadata.Builder	Metadata for long-running operations.
com.google.cloud.workstations.v1.StartWorkstationRequest	Request message for StartWorkstation.
com.google.cloud.workstations.v1.StartWorkstationRequest.Builder	Request message for StartWorkstation.
com.google.cloud.workstations.v1.StopWorkstationRequest	Request message for StopWorkstation.
com.google.cloud.workstations.v1.StopWorkstationRequest.Builder	Request message for StopWorkstation.
com.google.cloud.workstations.v1.UpdateWorkstationClusterRequest	Request message for UpdateWorkstationCluster.
com.google.cloud.workstations.v1.UpdateWorkstationClusterRequest.Builder	Request message for UpdateWorkstationCluster.
com.google.cloud.workstations.v1.UpdateWorkstationConfigRequest	Request message for UpdateWorkstationConfig.
com.google.cloud.workstations.v1.UpdateWorkstationConfigRequest.Builder	Request message for UpdateWorkstationConfig.
com.google.cloud.workstations.v1.UpdateWorkstationRequest	Request message for UpdateWorkstation.
com.google.cloud.workstations.v1.UpdateWorkstationRequest.Builder	Request message for UpdateWorkstation.
com.google.cloud.workstations.v1.Workstation	A single instance of a developer workstation with its own persistent storage.
com.google.cloud.workstations.v1.Workstation.Builder	A single instance of a developer workstation with its own persistent storage.
com.google.cloud.workstations.v1.Workstation.RuntimeHost	Runtime host for the workstation.
com.google.cloud.workstations.v1.Workstation.RuntimeHost.Builder	Runtime host for the workstation.
com.google.cloud.workstations.v1.Workstation.RuntimeHost.GceInstanceHost	The Compute Engine instance host.
com.google.cloud.workstations.v1.Workstation.RuntimeHost.GceInstanceHost.Builder	The Compute Engine instance host.
com.google.cloud.workstations.v1.Workstation.WorkstationPersistentDirectory	A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted.
com.google.cloud.workstations.v1.Workstation.WorkstationPersistentDirectory.Builder	A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted.
com.google.cloud.workstations.v1.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.v1.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.v1.WorkstationCluster.DomainConfig	Configuration options for a custom domain.
com.google.cloud.workstations.v1.WorkstationCluster.DomainConfig.Builder	Configuration options for a custom domain.
com.google.cloud.workstations.v1.WorkstationCluster.GatewayConfig	Configuration options for Cluster HTTP Gateway.
com.google.cloud.workstations.v1.WorkstationCluster.GatewayConfig.Builder	Configuration options for Cluster HTTP Gateway.
com.google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig	Configuration options for private workstation clusters.
com.google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig.Builder	Configuration options for private workstation clusters.
com.google.cloud.workstations.v1.WorkstationClusterName
com.google.cloud.workstations.v1.WorkstationClusterName.Builder	Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.
com.google.cloud.workstations.v1.WorkstationConfig	A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation
com.google.cloud.workstations.v1.WorkstationConfig.Builder	A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation
com.google.cloud.workstations.v1.WorkstationConfig.Container	A Docker container.
com.google.cloud.workstations.v1.WorkstationConfig.Container.Builder	A Docker container.
com.google.cloud.workstations.v1.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.v1.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.v1.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.v1.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.v1.WorkstationConfig.EphemeralDirectory.GcePersistentDisk	An EphemeralDirectory is backed by a Compute Engine persistent disk.
com.google.cloud.workstations.v1.WorkstationConfig.EphemeralDirectory.GcePersistentDisk.Builder	An EphemeralDirectory is backed by a Compute Engine persistent disk.
com.google.cloud.workstations.v1.WorkstationConfig.Host	Runtime host for a workstation.
com.google.cloud.workstations.v1.WorkstationConfig.Host.Builder	Runtime host for a workstation.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance	A runtime using a Compute Engine instance.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.Accelerator	An accelerator card attached to the instance.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.Accelerator.Builder	An accelerator card attached to the instance.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.BoostConfig	A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.BoostConfig.Builder	A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.Builder	A runtime using a Compute Engine instance.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig	A set of Compute Engine Confidential VM instance options.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder	A set of Compute Engine Confidential VM instance options.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig	A set of Compute Engine Shielded instance options.
com.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder	A set of Compute Engine Shielded instance options.
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory	A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.Builder	A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceHyperdiskBalancedHighAvailability	A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk.
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceHyperdiskBalancedHighAvailability.Builder	A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk.
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk	A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories
com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.Builder	A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories
com.google.cloud.workstations.v1.WorkstationConfig.PortRange	A PortRange defines a range of ports. Both first and last are
com.google.cloud.workstations.v1.WorkstationConfig.PortRange.Builder	A PortRange defines a range of ports. Both first and last are
com.google.cloud.workstations.v1.WorkstationConfig.ReadinessCheck	A readiness check to be performed on a workstation.
com.google.cloud.workstations.v1.WorkstationConfig.ReadinessCheck.Builder	A readiness check to be performed on a workstation.
com.google.cloud.workstations.v1.WorkstationConfigName
com.google.cloud.workstations.v1.WorkstationConfigName.Builder	Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}.
com.google.cloud.workstations.v1.WorkstationName
com.google.cloud.workstations.v1.WorkstationName.Builder	Builder for projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}.
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationConfigsFixedSizeCollection
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationConfigsPage
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationConfigsPagedResponse
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationsFixedSizeCollection
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationsPage
com.google.cloud.workstations.v1.WorkstationsClient.ListUsableWorkstationsPagedResponse
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationClustersFixedSizeCollection
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationClustersPage
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationClustersPagedResponse
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationConfigsFixedSizeCollection
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationConfigsPage
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationConfigsPagedResponse
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationsFixedSizeCollection
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationsPage
com.google.cloud.workstations.v1.WorkstationsClient.ListWorkstationsPagedResponse
com.google.cloud.workstations.v1.WorkstationsGrpc	Service for interacting with Cloud Workstations.
com.google.cloud.workstations.v1.WorkstationsGrpc.WorkstationsImplBase	Base class for the server implementation of the service Workstations. Service for interacting with Cloud Workstations.
com.google.cloud.workstations.v1.WorkstationsProto
com.google.cloud.workstations.v1.WorkstationsSettings.Builder	Builder for WorkstationsSettings.

Interfaces

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

Enums

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