Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource

The "workstations" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudWorkstations.v1
Assembly: Google.Apis.CloudWorkstations.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource

Constructors

WorkstationsResource(IClientService)

Constructs a new resource.

Declaration
public WorkstationsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Workstation, string)

Creates a new workstation.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.CreateRequest Create(Workstation body, string parent)
Parameters
Type Name Description
Workstation body

The body of the request.

string parent

Required. Parent resource name.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.CreateRequest

Delete(string)

Deletes the specified workstation.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Name of the workstation to delete.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.DeleteRequest

GenerateAccessToken(GenerateAccessTokenRequest, string)

Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GenerateAccessTokenRequest GenerateAccessToken(GenerateAccessTokenRequest body, string workstation)
Parameters
Type Name Description
GenerateAccessTokenRequest body

The body of the request.

string workstation

Required. Name of the workstation for which the access token should be generated.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GenerateAccessTokenRequest

Get(string)

Returns the requested workstation.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Name of the requested resource.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.GetIamPolicyRequest

List(string)

Returns all Workstations using the specified workstation configuration.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Parent resource name.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.ListRequest

ListUsable(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.ListUsableRequest ListUsable(string parent)
Parameters
Type Name Description
string parent

Required. Parent resource name.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.ListUsableRequest

Patch(Workstation, string)

Updates an existing workstation.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.PatchRequest Patch(Workstation body, string name)
Parameters
Type Name Description
Workstation body

The body of the request.

string name

Identifier. Full name of this workstation.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.SetIamPolicyRequest

Start(StartWorkstationRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.StartRequest Start(StartWorkstationRequest body, string name)
Parameters
Type Name Description
StartWorkstationRequest body

The body of the request.

string name

Required. Name of the workstation to start.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.StartRequest

Stop(StopWorkstationRequest, string)

Stops running a workstation, reducing costs.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.StopRequest Stop(StopWorkstationRequest body, string name)
Parameters
Type Name Description
StopWorkstationRequest body

The body of the request.

string name

Required. Name of the workstation to stop.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.StopRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration
public virtual ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.WorkstationClustersResource.WorkstationConfigsResource.WorkstationsResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX