Class WorkstationsGrpc.WorkstationsBlockingV2Stub (0.68.0)

public static final class WorkstationsGrpc.WorkstationsBlockingV2Stub extends AbstractBlockingStub<WorkstationsGrpc.WorkstationsBlockingV2Stub>

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

Service for interacting with Cloud Workstations.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > WorkstationsGrpc.WorkstationsBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected WorkstationsGrpc.WorkstationsBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
WorkstationsGrpc.WorkstationsBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createWorkstation(CreateWorkstationRequest request)

public Operation createWorkstation(CreateWorkstationRequest request)

Creates a new workstation.

Parameter
Name Description
request CreateWorkstationRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createWorkstationCluster(CreateWorkstationClusterRequest request)

public Operation createWorkstationCluster(CreateWorkstationClusterRequest request)

Creates a new workstation cluster.

Parameter
Name Description
request CreateWorkstationClusterRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createWorkstationConfig(CreateWorkstationConfigRequest request)

public Operation createWorkstationConfig(CreateWorkstationConfigRequest request)

Creates a new workstation configuration.

Parameter
Name Description
request CreateWorkstationConfigRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteWorkstation(DeleteWorkstationRequest request)

public Operation deleteWorkstation(DeleteWorkstationRequest request)

Deletes the specified workstation.

Parameter
Name Description
request DeleteWorkstationRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteWorkstationCluster(DeleteWorkstationClusterRequest request)

public Operation deleteWorkstationCluster(DeleteWorkstationClusterRequest request)

Deletes the specified workstation cluster.

Parameter
Name Description
request DeleteWorkstationClusterRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteWorkstationConfig(DeleteWorkstationConfigRequest request)

public Operation deleteWorkstationConfig(DeleteWorkstationConfigRequest request)

Deletes the specified workstation configuration.

Parameter
Name Description
request DeleteWorkstationConfigRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

generateAccessToken(GenerateAccessTokenRequest request)

public GenerateAccessTokenResponse generateAccessToken(GenerateAccessTokenRequest request)

Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.

Parameter
Name Description
request GenerateAccessTokenRequest
Returns
Type Description
GenerateAccessTokenResponse
Exceptions
Type Description
io.grpc.StatusException

getWorkstation(GetWorkstationRequest request)

public Workstation getWorkstation(GetWorkstationRequest request)

Returns the requested workstation.

Parameter
Name Description
request GetWorkstationRequest
Returns
Type Description
Workstation
Exceptions
Type Description
io.grpc.StatusException

getWorkstationCluster(GetWorkstationClusterRequest request)

public WorkstationCluster getWorkstationCluster(GetWorkstationClusterRequest request)

Returns the requested workstation cluster.

Parameter
Name Description
request GetWorkstationClusterRequest
Returns
Type Description
WorkstationCluster
Exceptions
Type Description
io.grpc.StatusException

getWorkstationConfig(GetWorkstationConfigRequest request)

public WorkstationConfig getWorkstationConfig(GetWorkstationConfigRequest request)

Returns the requested workstation configuration.

Parameter
Name Description
request GetWorkstationConfigRequest
Returns
Type Description
WorkstationConfig
Exceptions
Type Description
io.grpc.StatusException

listUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request)

public ListUsableWorkstationConfigsResponse listUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request)

Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.

Parameter
Name Description
request ListUsableWorkstationConfigsRequest
Returns
Type Description
ListUsableWorkstationConfigsResponse
Exceptions
Type Description
io.grpc.StatusException

listUsableWorkstations(ListUsableWorkstationsRequest request)

public ListUsableWorkstationsResponse listUsableWorkstations(ListUsableWorkstationsRequest request)

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

Parameter
Name Description
request ListUsableWorkstationsRequest
Returns
Type Description
ListUsableWorkstationsResponse
Exceptions
Type Description
io.grpc.StatusException

listWorkstationClusters(ListWorkstationClustersRequest request)

public ListWorkstationClustersResponse listWorkstationClusters(ListWorkstationClustersRequest request)

Returns all workstation clusters in the specified location.

Parameter
Name Description
request ListWorkstationClustersRequest
Returns
Type Description
ListWorkstationClustersResponse
Exceptions
Type Description
io.grpc.StatusException

listWorkstationConfigs(ListWorkstationConfigsRequest request)

public ListWorkstationConfigsResponse listWorkstationConfigs(ListWorkstationConfigsRequest request)

Returns all workstation configurations in the specified cluster.

Parameter
Name Description
request ListWorkstationConfigsRequest
Returns
Type Description
ListWorkstationConfigsResponse
Exceptions
Type Description
io.grpc.StatusException

listWorkstations(ListWorkstationsRequest request)

public ListWorkstationsResponse listWorkstations(ListWorkstationsRequest request)

Returns all Workstations using the specified workstation configuration.

Parameter
Name Description
request ListWorkstationsRequest
Returns
Type Description
ListWorkstationsResponse
Exceptions
Type Description
io.grpc.StatusException

startWorkstation(StartWorkstationRequest request)

public Operation startWorkstation(StartWorkstationRequest request)

Starts running a workstation so that users can connect to it.

Parameter
Name Description
request StartWorkstationRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

stopWorkstation(StopWorkstationRequest request)

public Operation stopWorkstation(StopWorkstationRequest request)

Stops running a workstation, reducing costs.

Parameter
Name Description
request StopWorkstationRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateWorkstation(UpdateWorkstationRequest request)

public Operation updateWorkstation(UpdateWorkstationRequest request)

Updates an existing workstation.

Parameter
Name Description
request UpdateWorkstationRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateWorkstationCluster(UpdateWorkstationClusterRequest request)

public Operation updateWorkstationCluster(UpdateWorkstationClusterRequest request)

Updates an existing workstation cluster.

Parameter
Name Description
request UpdateWorkstationClusterRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateWorkstationConfig(UpdateWorkstationConfigRequest request)

public Operation updateWorkstationConfig(UpdateWorkstationConfigRequest request)

Updates an existing workstation configuration.

Parameter
Name Description
request UpdateWorkstationConfigRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException