Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Workstations

import { Workstations } from "https://googleapis.deno.dev/v1/workstations:v1.ts";

Allows administrators to create managed developer environments in the cloud.

class Workstations {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsGet(name: string): Promise<Operation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;
async projectsLocationsWorkstationClustersCreate(
parent: string,
req: WorkstationCluster,
opts?: ProjectsLocationsWorkstationClustersCreateOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersDelete(name: string, opts?: ProjectsLocationsWorkstationClustersDeleteOptions): Promise<Operation>;
async projectsLocationsWorkstationClustersGet(name: string): Promise<WorkstationCluster>;
async projectsLocationsWorkstationClustersList(parent: string, opts?: ProjectsLocationsWorkstationClustersListOptions): Promise<ListWorkstationClustersResponse>;
async projectsLocationsWorkstationClustersPatch(
name: string,
req: WorkstationCluster,
opts?: ProjectsLocationsWorkstationClustersPatchOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsCreate(
parent: string,
req: WorkstationConfig,
opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsCreateOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsDelete(name: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteOptions): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsGet(name: string): Promise<WorkstationConfig>;
async projectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicy(resource: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsWorkstationClustersWorkstationConfigsList(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsListOptions): Promise<ListWorkstationConfigsResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsListUsable(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableOptions): Promise<ListUsableWorkstationConfigsResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsPatch(
name: string,
req: WorkstationConfig,
opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsPatchOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreate(
parent: string,
req: Workstation,
opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDelete(name: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteOptions): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessToken(workstation: string, req: GenerateAccessTokenRequest): Promise<GenerateAccessTokenResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGet(name: string): Promise<Workstation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicy(resource: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsList(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListOptions): Promise<ListWorkstationsResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsable(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableOptions): Promise<ListUsableWorkstationsResponse>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatch(
name: string,
req: Workstation,
opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchOptions,
): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStart(name: string, req: StartWorkstationRequest): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStop(name: string, req: StopWorkstationRequest): Promise<Operation>;
async projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
}

§Constructors

§
new Workstations(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<GoogleProtobufEmpty>
[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<Operation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsWorkstationClustersCreate(parent: string, req: WorkstationCluster, opts?: ProjectsLocationsWorkstationClustersCreateOptions): Promise<Operation>
[src]

Creates a new workstation cluster.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersDelete(name: string, opts?: ProjectsLocationsWorkstationClustersDeleteOptions): Promise<Operation>
[src]

Deletes the specified workstation cluster.

@param name

Required. Name of the workstation cluster to delete.

§
projectsLocationsWorkstationClustersGet(name: string): Promise<WorkstationCluster>
[src]

Returns the requested workstation cluster.

@param name

Required. Name of the requested resource.

§
projectsLocationsWorkstationClustersList(parent: string, opts?: ProjectsLocationsWorkstationClustersListOptions): Promise<ListWorkstationClustersResponse>
[src]

Returns all workstation clusters in the specified location.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersPatch(name: string, req: WorkstationCluster, opts?: ProjectsLocationsWorkstationClustersPatchOptions): Promise<Operation>
[src]

Updates an existing workstation cluster.

@param name

Identifier. Full name of this workstation cluster.

§
projectsLocationsWorkstationClustersWorkstationConfigsCreate(parent: string, req: WorkstationConfig, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsCreateOptions): Promise<Operation>
[src]

Creates a new workstation configuration.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsDelete(name: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteOptions): Promise<Operation>
[src]

Deletes the specified workstation configuration.

@param name

Required. Name of the workstation configuration to delete.

§
projectsLocationsWorkstationClustersWorkstationConfigsGet(name: string): Promise<WorkstationConfig>
[src]

Returns the requested workstation configuration.

@param name

Required. Name of the requested resource.

§
projectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicy(resource: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyOptions): Promise<Policy>
[src]

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

@param resource

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

§
projectsLocationsWorkstationClustersWorkstationConfigsList(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsListOptions): Promise<ListWorkstationConfigsResponse>
[src]

Returns all workstation configurations in the specified cluster.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsListUsable(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableOptions): Promise<ListUsableWorkstationConfigsResponse>
[src]

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

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsPatch(name: string, req: WorkstationConfig, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsPatchOptions): Promise<Operation>
[src]

Updates an existing workstation configuration.

@param name

Identifier. Full name of this workstation configuration.

§
projectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

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

@param resource

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

§
projectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

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

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreate(parent: string, req: Workstation, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateOptions): Promise<Operation>
[src]

Creates a new workstation.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDelete(name: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteOptions): Promise<Operation>
[src]

Deletes the specified workstation.

@param name

Required. Name of the workstation to delete.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessToken(workstation: string, req: GenerateAccessTokenRequest): Promise<GenerateAccessTokenResponse>
[src]

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

@param workstation

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

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGet(name: string): Promise<Workstation>
[src]

Returns the requested workstation.

@param name

Required. Name of the requested resource.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicy(resource: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyOptions): Promise<Policy>
[src]

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

@param resource

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

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsList(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListOptions): Promise<ListWorkstationsResponse>
[src]

Returns all Workstations using the specified workstation configuration.

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsable(parent: string, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableOptions): Promise<ListUsableWorkstationsResponse>
[src]

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

@param parent

Required. Parent resource name.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatch(name: string, req: Workstation, opts?: ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchOptions): Promise<Operation>
[src]

Updates an existing workstation.

@param name

Identifier. Full name of this workstation.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

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

@param resource

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

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStart(name: string, req: StartWorkstationRequest): Promise<Operation>
[src]

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

@param name

Required. Name of the workstation to start.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStop(name: string, req: StopWorkstationRequest): Promise<Operation>
[src]

Stops running a workstation, reducing costs.

@param name

Required. Name of the workstation to stop.

§
projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

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