Interface WorkstationsGrpc.AsyncService (0.37.0)

public static interface WorkstationsGrpc.AsyncService

Service for interacting with Cloud Workstations.

Methods

createWorkstation(CreateWorkstationRequest request, StreamObserver<Operation> responseObserver)

public default void createWorkstation(CreateWorkstationRequest request, StreamObserver<Operation> responseObserver)

Creates a new workstation.

Parameters
Name Description
request CreateWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createWorkstationCluster(CreateWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

public default void createWorkstationCluster(CreateWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

Creates a new workstation cluster.

Parameters
Name Description
request CreateWorkstationClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createWorkstationConfig(CreateWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

public default void createWorkstationConfig(CreateWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

Creates a new workstation configuration.

Parameters
Name Description
request CreateWorkstationConfigRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteWorkstation(DeleteWorkstationRequest request, StreamObserver<Operation> responseObserver)

public default void deleteWorkstation(DeleteWorkstationRequest request, StreamObserver<Operation> responseObserver)

Deletes the specified workstation.

Parameters
Name Description
request DeleteWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteWorkstationCluster(DeleteWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

public default void deleteWorkstationCluster(DeleteWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

Deletes the specified workstation cluster.

Parameters
Name Description
request DeleteWorkstationClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteWorkstationConfig(DeleteWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

public default void deleteWorkstationConfig(DeleteWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

Deletes the specified workstation configuration.

Parameters
Name Description
request DeleteWorkstationConfigRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

generateAccessToken(GenerateAccessTokenRequest request, StreamObserver<GenerateAccessTokenResponse> responseObserver)

public default void generateAccessToken(GenerateAccessTokenRequest request, StreamObserver<GenerateAccessTokenResponse> responseObserver)

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

Parameters
Name Description
request GenerateAccessTokenRequest
responseObserver io.grpc.stub.StreamObserver<GenerateAccessTokenResponse>

getWorkstation(GetWorkstationRequest request, StreamObserver<Workstation> responseObserver)

public default void getWorkstation(GetWorkstationRequest request, StreamObserver<Workstation> responseObserver)

Returns the requested workstation.

Parameters
Name Description
request GetWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Workstation>

getWorkstationCluster(GetWorkstationClusterRequest request, StreamObserver<WorkstationCluster> responseObserver)

public default void getWorkstationCluster(GetWorkstationClusterRequest request, StreamObserver<WorkstationCluster> responseObserver)

Returns the requested workstation cluster.

Parameters
Name Description
request GetWorkstationClusterRequest
responseObserver io.grpc.stub.StreamObserver<WorkstationCluster>

getWorkstationConfig(GetWorkstationConfigRequest request, StreamObserver<WorkstationConfig> responseObserver)

public default void getWorkstationConfig(GetWorkstationConfigRequest request, StreamObserver<WorkstationConfig> responseObserver)

Returns the requested workstation configuration.

Parameters
Name Description
request GetWorkstationConfigRequest
responseObserver io.grpc.stub.StreamObserver<WorkstationConfig>

listUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request, StreamObserver<ListUsableWorkstationConfigsResponse> responseObserver)

public default void listUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request, StreamObserver<ListUsableWorkstationConfigsResponse> responseObserver)

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

Parameters
Name Description
request ListUsableWorkstationConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListUsableWorkstationConfigsResponse>

listUsableWorkstations(ListUsableWorkstationsRequest request, StreamObserver<ListUsableWorkstationsResponse> responseObserver)

public default void listUsableWorkstations(ListUsableWorkstationsRequest request, StreamObserver<ListUsableWorkstationsResponse> responseObserver)

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

Parameters
Name Description
request ListUsableWorkstationsRequest
responseObserver io.grpc.stub.StreamObserver<ListUsableWorkstationsResponse>

listWorkstationClusters(ListWorkstationClustersRequest request, StreamObserver<ListWorkstationClustersResponse> responseObserver)

public default void listWorkstationClusters(ListWorkstationClustersRequest request, StreamObserver<ListWorkstationClustersResponse> responseObserver)

Returns all workstation clusters in the specified location.

Parameters
Name Description
request ListWorkstationClustersRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkstationClustersResponse>

listWorkstationConfigs(ListWorkstationConfigsRequest request, StreamObserver<ListWorkstationConfigsResponse> responseObserver)

public default void listWorkstationConfigs(ListWorkstationConfigsRequest request, StreamObserver<ListWorkstationConfigsResponse> responseObserver)

Returns all workstation configurations in the specified cluster.

Parameters
Name Description
request ListWorkstationConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkstationConfigsResponse>

listWorkstations(ListWorkstationsRequest request, StreamObserver<ListWorkstationsResponse> responseObserver)

public default void listWorkstations(ListWorkstationsRequest request, StreamObserver<ListWorkstationsResponse> responseObserver)

Returns all Workstations using the specified workstation configuration.

Parameters
Name Description
request ListWorkstationsRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkstationsResponse>

startWorkstation(StartWorkstationRequest request, StreamObserver<Operation> responseObserver)

public default void startWorkstation(StartWorkstationRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request StartWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

stopWorkstation(StopWorkstationRequest request, StreamObserver<Operation> responseObserver)

public default void stopWorkstation(StopWorkstationRequest request, StreamObserver<Operation> responseObserver)

Stops running a workstation, reducing costs.

Parameters
Name Description
request StopWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateWorkstation(UpdateWorkstationRequest request, StreamObserver<Operation> responseObserver)

public default void updateWorkstation(UpdateWorkstationRequest request, StreamObserver<Operation> responseObserver)

Updates an existing workstation.

Parameters
Name Description
request UpdateWorkstationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateWorkstationCluster(UpdateWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

public default void updateWorkstationCluster(UpdateWorkstationClusterRequest request, StreamObserver<Operation> responseObserver)

Updates an existing workstation cluster.

Parameters
Name Description
request UpdateWorkstationClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateWorkstationConfig(UpdateWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

public default void updateWorkstationConfig(UpdateWorkstationConfigRequest request, StreamObserver<Operation> responseObserver)

Updates an existing workstation configuration.

Parameters
Name Description
request UpdateWorkstationConfigRequest
responseObserver io.grpc.stub.StreamObserver<Operation>