Cloud Workstations v1 API - Class Workstations.WorkstationsBase (1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(Workstations), "BindService")]
public abstract class Workstations.WorkstationsBase

Reference documentation and code samples for the Cloud Workstations v1 API class Workstations.WorkstationsBase.

Base class for server-side implementations of Workstations

Inheritance

object > Workstations.WorkstationsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Workstations.V1

Assembly

Google.Cloud.Workstations.V1.dll

Methods

CreateWorkstation(CreateWorkstationRequest, ServerCallContext)

public virtual Task<Operation> CreateWorkstation(CreateWorkstationRequest request, ServerCallContext context)

Creates a new workstation.

Parameters
Name	Description
request	CreateWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateWorkstationCluster(CreateWorkstationClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateWorkstationCluster(CreateWorkstationClusterRequest request, ServerCallContext context)

Creates a new workstation cluster.

Parameters
Name	Description
request	CreateWorkstationClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateWorkstationConfig(CreateWorkstationConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateWorkstationConfig(CreateWorkstationConfigRequest request, ServerCallContext context)

Creates a new workstation configuration.

Parameters
Name	Description
request	CreateWorkstationConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteWorkstation(DeleteWorkstationRequest, ServerCallContext)

public virtual Task<Operation> DeleteWorkstation(DeleteWorkstationRequest request, ServerCallContext context)

Deletes the specified workstation.

Parameters
Name	Description
request	DeleteWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteWorkstationCluster(DeleteWorkstationClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteWorkstationCluster(DeleteWorkstationClusterRequest request, ServerCallContext context)

Deletes the specified workstation cluster.

Parameters
Name	Description
request	DeleteWorkstationClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteWorkstationConfig(DeleteWorkstationConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteWorkstationConfig(DeleteWorkstationConfigRequest request, ServerCallContext context)

Deletes the specified workstation configuration.

Parameters
Name	Description
request	DeleteWorkstationConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateAccessToken(GenerateAccessTokenRequest, ServerCallContext)

public virtual Task<GenerateAccessTokenResponse> GenerateAccessToken(GenerateAccessTokenRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GenerateAccessTokenRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateAccessTokenResponse	The response to send back to the client (wrapped by a task).

GetWorkstation(GetWorkstationRequest, ServerCallContext)

public virtual Task<Workstation> GetWorkstation(GetWorkstationRequest request, ServerCallContext context)

Returns the requested workstation.

Parameters
Name	Description
request	GetWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWorkstation	The response to send back to the client (wrapped by a task).

GetWorkstationCluster(GetWorkstationClusterRequest, ServerCallContext)

public virtual Task<WorkstationCluster> GetWorkstationCluster(GetWorkstationClusterRequest request, ServerCallContext context)

Returns the requested workstation cluster.

Parameters
Name	Description
request	GetWorkstationClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWorkstationCluster	The response to send back to the client (wrapped by a task).

GetWorkstationConfig(GetWorkstationConfigRequest, ServerCallContext)

public virtual Task<WorkstationConfig> GetWorkstationConfig(GetWorkstationConfigRequest request, ServerCallContext context)

Returns the requested workstation configuration.

Parameters
Name	Description
request	GetWorkstationConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWorkstationConfig	The response to send back to the client (wrapped by a task).

ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest, ServerCallContext)

public virtual Task<ListUsableWorkstationConfigsResponse> ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListUsableWorkstationConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListUsableWorkstationConfigsResponse	The response to send back to the client (wrapped by a task).

ListUsableWorkstations(ListUsableWorkstationsRequest, ServerCallContext)

public virtual Task<ListUsableWorkstationsResponse> ListUsableWorkstations(ListUsableWorkstationsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListUsableWorkstationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListUsableWorkstationsResponse	The response to send back to the client (wrapped by a task).

ListWorkstationClusters(ListWorkstationClustersRequest, ServerCallContext)

public virtual Task<ListWorkstationClustersResponse> ListWorkstationClusters(ListWorkstationClustersRequest request, ServerCallContext context)

Returns all workstation clusters in the specified location.

Parameters
Name	Description
request	ListWorkstationClustersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListWorkstationClustersResponse	The response to send back to the client (wrapped by a task).

ListWorkstationConfigs(ListWorkstationConfigsRequest, ServerCallContext)

public virtual Task<ListWorkstationConfigsResponse> ListWorkstationConfigs(ListWorkstationConfigsRequest request, ServerCallContext context)

Returns all workstation configurations in the specified cluster.

Parameters
Name	Description
request	ListWorkstationConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListWorkstationConfigsResponse	The response to send back to the client (wrapped by a task).

ListWorkstations(ListWorkstationsRequest, ServerCallContext)

public virtual Task<ListWorkstationsResponse> ListWorkstations(ListWorkstationsRequest request, ServerCallContext context)

Returns all Workstations using the specified workstation configuration.

Parameters
Name	Description
request	ListWorkstationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListWorkstationsResponse	The response to send back to the client (wrapped by a task).

StartWorkstation(StartWorkstationRequest, ServerCallContext)

public virtual Task<Operation> StartWorkstation(StartWorkstationRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	StartWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StopWorkstation(StopWorkstationRequest, ServerCallContext)

public virtual Task<Operation> StopWorkstation(StopWorkstationRequest request, ServerCallContext context)

Stops running a workstation, reducing costs.

Parameters
Name	Description
request	StopWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateWorkstation(UpdateWorkstationRequest, ServerCallContext)

public virtual Task<Operation> UpdateWorkstation(UpdateWorkstationRequest request, ServerCallContext context)

Updates an existing workstation.

Parameters
Name	Description
request	UpdateWorkstationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateWorkstationCluster(UpdateWorkstationClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateWorkstationCluster(UpdateWorkstationClusterRequest request, ServerCallContext context)

Updates an existing workstation cluster.

Parameters
Name	Description
request	UpdateWorkstationClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateWorkstationConfig(UpdateWorkstationConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateWorkstationConfig(UpdateWorkstationConfigRequest request, ServerCallContext context)

Updates an existing workstation configuration.

Parameters
Name	Description
request	UpdateWorkstationConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).