Cloud Workstations v1 API - Class Workstations.WorkstationsClient (1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class Workstations.WorkstationsClient : ClientBase<Workstations.WorkstationsClient>

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

Client for Workstations

Inheritance

object > ClientBase > ClientBaseWorkstationsWorkstationsClient > Workstations.WorkstationsClient

Inherited Members

ClientBase<Workstations.WorkstationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Workstations.V1

Assembly

Google.Cloud.Workstations.V1.dll

Constructors

WorkstationsClient()

protected WorkstationsClient()

Protected parameterless constructor to allow creation of test doubles.

WorkstationsClient(CallInvoker)

public WorkstationsClient(CallInvoker callInvoker)

Creates a new client for Workstations that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

WorkstationsClient(ChannelBase)

public WorkstationsClient(ChannelBase channel)

Creates a new client for Workstations

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

WorkstationsClient(ClientBaseConfiguration)

protected WorkstationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateWorkstation(CreateWorkstationRequest, CallOptions)

public virtual Operation CreateWorkstation(CreateWorkstationRequest request, CallOptions options)

Creates a new workstation.

Parameters
Name	Description
request	CreateWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstation(CreateWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkstation(CreateWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation.

Parameters
Name	Description
request	CreateWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstationAsync(CreateWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkstationAsync(CreateWorkstationRequest request, CallOptions options)

Creates a new workstation.

Parameters
Name	Description
request	CreateWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkstationAsync(CreateWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkstationAsync(CreateWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation.

Parameters
Name	Description
request	CreateWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkstationCluster(CreateWorkstationClusterRequest, CallOptions)

public virtual Operation CreateWorkstationCluster(CreateWorkstationClusterRequest request, CallOptions options)

Creates a new workstation cluster.

Parameters
Name	Description
request	CreateWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstationCluster(CreateWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkstationCluster(CreateWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation cluster.

Parameters
Name	Description
request	CreateWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstationClusterAsync(CreateWorkstationClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkstationClusterAsync(CreateWorkstationClusterRequest request, CallOptions options)

Creates a new workstation cluster.

Parameters
Name	Description
request	CreateWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkstationClusterAsync(CreateWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkstationClusterAsync(CreateWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation cluster.

Parameters
Name	Description
request	CreateWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkstationConfig(CreateWorkstationConfigRequest, CallOptions)

public virtual Operation CreateWorkstationConfig(CreateWorkstationConfigRequest request, CallOptions options)

Creates a new workstation configuration.

Parameters
Name	Description
request	CreateWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstationConfig(CreateWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkstationConfig(CreateWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation configuration.

Parameters
Name	Description
request	CreateWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkstationConfigAsync(CreateWorkstationConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkstationConfigAsync(CreateWorkstationConfigRequest request, CallOptions options)

Creates a new workstation configuration.

Parameters
Name	Description
request	CreateWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkstationConfigAsync(CreateWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkstationConfigAsync(CreateWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new workstation configuration.

Parameters
Name	Description
request	CreateWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstation(DeleteWorkstationRequest, CallOptions)

public virtual Operation DeleteWorkstation(DeleteWorkstationRequest request, CallOptions options)

Deletes the specified workstation.

Parameters
Name	Description
request	DeleteWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstation(DeleteWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteWorkstation(DeleteWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation.

Parameters
Name	Description
request	DeleteWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstationAsync(DeleteWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationAsync(DeleteWorkstationRequest request, CallOptions options)

Deletes the specified workstation.

Parameters
Name	Description
request	DeleteWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstationAsync(DeleteWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationAsync(DeleteWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation.

Parameters
Name	Description
request	DeleteWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstationCluster(DeleteWorkstationClusterRequest, CallOptions)

public virtual Operation DeleteWorkstationCluster(DeleteWorkstationClusterRequest request, CallOptions options)

Deletes the specified workstation cluster.

Parameters
Name	Description
request	DeleteWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstationCluster(DeleteWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteWorkstationCluster(DeleteWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation cluster.

Parameters
Name	Description
request	DeleteWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstationClusterAsync(DeleteWorkstationClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationClusterAsync(DeleteWorkstationClusterRequest request, CallOptions options)

Deletes the specified workstation cluster.

Parameters
Name	Description
request	DeleteWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstationClusterAsync(DeleteWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationClusterAsync(DeleteWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation cluster.

Parameters
Name	Description
request	DeleteWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstationConfig(DeleteWorkstationConfigRequest, CallOptions)

public virtual Operation DeleteWorkstationConfig(DeleteWorkstationConfigRequest request, CallOptions options)

Deletes the specified workstation configuration.

Parameters
Name	Description
request	DeleteWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstationConfig(DeleteWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteWorkstationConfig(DeleteWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation configuration.

Parameters
Name	Description
request	DeleteWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkstationConfigAsync(DeleteWorkstationConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationConfigAsync(DeleteWorkstationConfigRequest request, CallOptions options)

Deletes the specified workstation configuration.

Parameters
Name	Description
request	DeleteWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkstationConfigAsync(DeleteWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteWorkstationConfigAsync(DeleteWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified workstation configuration.

Parameters
Name	Description
request	DeleteWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GenerateAccessToken(GenerateAccessTokenRequest, CallOptions)

public virtual GenerateAccessTokenResponse GenerateAccessToken(GenerateAccessTokenRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GenerateAccessTokenResponse	The response received from the server.

GenerateAccessToken(GenerateAccessTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateAccessTokenResponse GenerateAccessToken(GenerateAccessTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GenerateAccessTokenResponse	The response received from the server.

GenerateAccessTokenAsync(GenerateAccessTokenRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateAccessTokenResponse> GenerateAccessTokenAsync(GenerateAccessTokenRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGenerateAccessTokenResponse	The call object.

GenerateAccessTokenAsync(GenerateAccessTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateAccessTokenResponse> GenerateAccessTokenAsync(GenerateAccessTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGenerateAccessTokenResponse	The call object.

GetWorkstation(GetWorkstationRequest, CallOptions)

public virtual Workstation GetWorkstation(GetWorkstationRequest request, CallOptions options)

Returns the requested workstation.

Parameters
Name	Description
request	GetWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Workstation	The response received from the server.

GetWorkstation(GetWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Workstation GetWorkstation(GetWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation.

Parameters
Name	Description
request	GetWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Workstation	The response received from the server.

GetWorkstationAsync(GetWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Workstation> GetWorkstationAsync(GetWorkstationRequest request, CallOptions options)

Returns the requested workstation.

Parameters
Name	Description
request	GetWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallWorkstation	The call object.

GetWorkstationAsync(GetWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Workstation> GetWorkstationAsync(GetWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation.

Parameters
Name	Description
request	GetWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallWorkstation	The call object.

GetWorkstationCluster(GetWorkstationClusterRequest, CallOptions)

public virtual WorkstationCluster GetWorkstationCluster(GetWorkstationClusterRequest request, CallOptions options)

Returns the requested workstation cluster.

Parameters
Name	Description
request	GetWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
WorkstationCluster	The response received from the server.

GetWorkstationCluster(GetWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual WorkstationCluster GetWorkstationCluster(GetWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation cluster.

Parameters
Name	Description
request	GetWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
WorkstationCluster	The response received from the server.

GetWorkstationClusterAsync(GetWorkstationClusterRequest, CallOptions)

public virtual AsyncUnaryCall<WorkstationCluster> GetWorkstationClusterAsync(GetWorkstationClusterRequest request, CallOptions options)

Returns the requested workstation cluster.

Parameters
Name	Description
request	GetWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallWorkstationCluster	The call object.

GetWorkstationClusterAsync(GetWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<WorkstationCluster> GetWorkstationClusterAsync(GetWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation cluster.

Parameters
Name	Description
request	GetWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallWorkstationCluster	The call object.

GetWorkstationConfig(GetWorkstationConfigRequest, CallOptions)

public virtual WorkstationConfig GetWorkstationConfig(GetWorkstationConfigRequest request, CallOptions options)

Returns the requested workstation configuration.

Parameters
Name	Description
request	GetWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
WorkstationConfig	The response received from the server.

GetWorkstationConfig(GetWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual WorkstationConfig GetWorkstationConfig(GetWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation configuration.

Parameters
Name	Description
request	GetWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
WorkstationConfig	The response received from the server.

GetWorkstationConfigAsync(GetWorkstationConfigRequest, CallOptions)

public virtual AsyncUnaryCall<WorkstationConfig> GetWorkstationConfigAsync(GetWorkstationConfigRequest request, CallOptions options)

Returns the requested workstation configuration.

Parameters
Name	Description
request	GetWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallWorkstationConfig	The call object.

GetWorkstationConfigAsync(GetWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<WorkstationConfig> GetWorkstationConfigAsync(GetWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the requested workstation configuration.

Parameters
Name	Description
request	GetWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallWorkstationConfig	The call object.

ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest, CallOptions)

public virtual ListUsableWorkstationConfigsResponse ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListUsableWorkstationConfigsResponse	The response received from the server.

ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListUsableWorkstationConfigsResponse ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListUsableWorkstationConfigsResponse	The response received from the server.

ListUsableWorkstationConfigsAsync(ListUsableWorkstationConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListUsableWorkstationConfigsResponse> ListUsableWorkstationConfigsAsync(ListUsableWorkstationConfigsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListUsableWorkstationConfigsResponse	The call object.

ListUsableWorkstationConfigsAsync(ListUsableWorkstationConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListUsableWorkstationConfigsResponse> ListUsableWorkstationConfigsAsync(ListUsableWorkstationConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListUsableWorkstationConfigsResponse	The call object.

ListUsableWorkstations(ListUsableWorkstationsRequest, CallOptions)

public virtual ListUsableWorkstationsResponse ListUsableWorkstations(ListUsableWorkstationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListUsableWorkstationsResponse	The response received from the server.

ListUsableWorkstations(ListUsableWorkstationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListUsableWorkstationsResponse ListUsableWorkstations(ListUsableWorkstationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListUsableWorkstationsResponse	The response received from the server.

ListUsableWorkstationsAsync(ListUsableWorkstationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListUsableWorkstationsResponse> ListUsableWorkstationsAsync(ListUsableWorkstationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListUsableWorkstationsResponse	The call object.

ListUsableWorkstationsAsync(ListUsableWorkstationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListUsableWorkstationsResponse> ListUsableWorkstationsAsync(ListUsableWorkstationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListUsableWorkstationsResponse	The call object.

ListWorkstationClusters(ListWorkstationClustersRequest, CallOptions)

public virtual ListWorkstationClustersResponse ListWorkstationClusters(ListWorkstationClustersRequest request, CallOptions options)

Returns all workstation clusters in the specified location.

Parameters
Name	Description
request	ListWorkstationClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListWorkstationClustersResponse	The response received from the server.

ListWorkstationClusters(ListWorkstationClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkstationClustersResponse ListWorkstationClusters(ListWorkstationClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all workstation clusters in the specified location.

Parameters
Name	Description
request	ListWorkstationClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListWorkstationClustersResponse	The response received from the server.

ListWorkstationClustersAsync(ListWorkstationClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkstationClustersResponse> ListWorkstationClustersAsync(ListWorkstationClustersRequest request, CallOptions options)

Returns all workstation clusters in the specified location.

Parameters
Name	Description
request	ListWorkstationClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationClustersResponse	The call object.

ListWorkstationClustersAsync(ListWorkstationClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkstationClustersResponse> ListWorkstationClustersAsync(ListWorkstationClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all workstation clusters in the specified location.

Parameters
Name	Description
request	ListWorkstationClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationClustersResponse	The call object.

ListWorkstationConfigs(ListWorkstationConfigsRequest, CallOptions)

public virtual ListWorkstationConfigsResponse ListWorkstationConfigs(ListWorkstationConfigsRequest request, CallOptions options)

Returns all workstation configurations in the specified cluster.

Parameters
Name	Description
request	ListWorkstationConfigsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListWorkstationConfigsResponse	The response received from the server.

ListWorkstationConfigs(ListWorkstationConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkstationConfigsResponse ListWorkstationConfigs(ListWorkstationConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all workstation configurations in the specified cluster.

Parameters
Name	Description
request	ListWorkstationConfigsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListWorkstationConfigsResponse	The response received from the server.

ListWorkstationConfigsAsync(ListWorkstationConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkstationConfigsResponse> ListWorkstationConfigsAsync(ListWorkstationConfigsRequest request, CallOptions options)

Returns all workstation configurations in the specified cluster.

Parameters
Name	Description
request	ListWorkstationConfigsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationConfigsResponse	The call object.

ListWorkstationConfigsAsync(ListWorkstationConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkstationConfigsResponse> ListWorkstationConfigsAsync(ListWorkstationConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all workstation configurations in the specified cluster.

Parameters
Name	Description
request	ListWorkstationConfigsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationConfigsResponse	The call object.

ListWorkstations(ListWorkstationsRequest, CallOptions)

public virtual ListWorkstationsResponse ListWorkstations(ListWorkstationsRequest request, CallOptions options)

Returns all Workstations using the specified workstation configuration.

Parameters
Name	Description
request	ListWorkstationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListWorkstationsResponse	The response received from the server.

ListWorkstations(ListWorkstationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkstationsResponse ListWorkstations(ListWorkstationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all Workstations using the specified workstation configuration.

Parameters
Name	Description
request	ListWorkstationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListWorkstationsResponse	The response received from the server.

ListWorkstationsAsync(ListWorkstationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkstationsResponse> ListWorkstationsAsync(ListWorkstationsRequest request, CallOptions options)

Returns all Workstations using the specified workstation configuration.

Parameters
Name	Description
request	ListWorkstationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationsResponse	The call object.

ListWorkstationsAsync(ListWorkstationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkstationsResponse> ListWorkstationsAsync(ListWorkstationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all Workstations using the specified workstation configuration.

Parameters
Name	Description
request	ListWorkstationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListWorkstationsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Workstations.WorkstationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
WorkstationsWorkstationsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Workstations.V1.Workstations.WorkstationsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StartWorkstation(StartWorkstationRequest, CallOptions)

public virtual Operation StartWorkstation(StartWorkstationRequest request, CallOptions options)

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

Parameters
Name	Description
request	StartWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

StartWorkstation(StartWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation StartWorkstation(StartWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	StartWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

StartWorkstationAsync(StartWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartWorkstationAsync(StartWorkstationRequest request, CallOptions options)

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

Parameters
Name	Description
request	StartWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

StartWorkstationAsync(StartWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartWorkstationAsync(StartWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	StartWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

StopWorkstation(StopWorkstationRequest, CallOptions)

public virtual Operation StopWorkstation(StopWorkstationRequest request, CallOptions options)

Stops running a workstation, reducing costs.

Parameters
Name	Description
request	StopWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

StopWorkstation(StopWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation StopWorkstation(StopWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops running a workstation, reducing costs.

Parameters
Name	Description
request	StopWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

StopWorkstationAsync(StopWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopWorkstationAsync(StopWorkstationRequest request, CallOptions options)

Stops running a workstation, reducing costs.

Parameters
Name	Description
request	StopWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

StopWorkstationAsync(StopWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopWorkstationAsync(StopWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops running a workstation, reducing costs.

Parameters
Name	Description
request	StopWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstation(UpdateWorkstationRequest, CallOptions)

public virtual Operation UpdateWorkstation(UpdateWorkstationRequest request, CallOptions options)

Updates an existing workstation.

Parameters
Name	Description
request	UpdateWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstation(UpdateWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateWorkstation(UpdateWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation.

Parameters
Name	Description
request	UpdateWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstationAsync(UpdateWorkstationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationAsync(UpdateWorkstationRequest request, CallOptions options)

Updates an existing workstation.

Parameters
Name	Description
request	UpdateWorkstationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstationAsync(UpdateWorkstationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationAsync(UpdateWorkstationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation.

Parameters
Name	Description
request	UpdateWorkstationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstationCluster(UpdateWorkstationClusterRequest, CallOptions)

public virtual Operation UpdateWorkstationCluster(UpdateWorkstationClusterRequest request, CallOptions options)

Updates an existing workstation cluster.

Parameters
Name	Description
request	UpdateWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstationCluster(UpdateWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateWorkstationCluster(UpdateWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation cluster.

Parameters
Name	Description
request	UpdateWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstationClusterAsync(UpdateWorkstationClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationClusterAsync(UpdateWorkstationClusterRequest request, CallOptions options)

Updates an existing workstation cluster.

Parameters
Name	Description
request	UpdateWorkstationClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstationClusterAsync(UpdateWorkstationClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationClusterAsync(UpdateWorkstationClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation cluster.

Parameters
Name	Description
request	UpdateWorkstationClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstationConfig(UpdateWorkstationConfigRequest, CallOptions)

public virtual Operation UpdateWorkstationConfig(UpdateWorkstationConfigRequest request, CallOptions options)

Updates an existing workstation configuration.

Parameters
Name	Description
request	UpdateWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstationConfig(UpdateWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateWorkstationConfig(UpdateWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation configuration.

Parameters
Name	Description
request	UpdateWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkstationConfigAsync(UpdateWorkstationConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationConfigAsync(UpdateWorkstationConfigRequest request, CallOptions options)

Updates an existing workstation configuration.

Parameters
Name	Description
request	UpdateWorkstationConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkstationConfigAsync(UpdateWorkstationConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateWorkstationConfigAsync(UpdateWorkstationConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing workstation configuration.

Parameters
Name	Description
request	UpdateWorkstationConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.