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

Usage

import * as mod from "https://googleapis.deno.dev/v1/workstations:v1.ts";

§Classes

GoogleAuth
Workstations

Allows administrators to create managed developer environments in the cloud.

§Variables

auth

§Interfaces

Accelerator

An accelerator card attached to the instance.

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Binding

Associates members, or principals, with a role.

CancelOperationRequest

The request message for Operations.CancelOperation.

Container

A Docker container.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

CustomerEncryptionKey

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.

DomainConfig

Configuration options for a custom domain.

EphemeralDirectory

An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GceConfidentialInstanceConfig

A set of Compute Engine Confidential VM instance options.

GceInstance

A runtime using a Compute Engine instance.

GcePersistentDisk

An EphemeralDirectory is backed by a Compute Engine persistent disk.

GceRegionalPersistentDisk

A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a persistent disk that mounts to the workstation VM at /home when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.

GceShieldedInstanceConfig

A set of Compute Engine Shielded instance options.

GenerateAccessTokenRequest

Request message for GenerateAccessToken.

GenerateAccessTokenResponse

Response message for GenerateAccessToken.

GoogleProtobufEmpty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Host

Runtime host for a workstation.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListUsableWorkstationConfigsResponse

Response message for ListUsableWorkstationConfigs.

ListUsableWorkstationsResponse

Response message for ListUsableWorkstations.

ListWorkstationClustersResponse

Response message for ListWorkstationClusters.

ListWorkstationConfigsResponse

Response message for ListWorkstationConfigs.

ListWorkstationsResponse

Response message for ListWorkstations.

Location

A resource that represents a Google Cloud location.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata

Metadata for long-running operations.

PersistentDirectory

A directory to persist across workstation sessions.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: ``` bindings: - members:

PrivateClusterConfig

Configuration options for private workstation clusters.

ProjectsLocationsListOptions

Additional options for Workstations#projectsLocationsList.

ProjectsLocationsOperationsListOptions

Additional options for Workstations#projectsLocationsOperationsList.

ProjectsLocationsWorkstationClustersCreateOptions

Additional options for Workstations#projectsLocationsWorkstationClustersCreate.

ProjectsLocationsWorkstationClustersDeleteOptions

Additional options for Workstations#projectsLocationsWorkstationClustersDelete.

ProjectsLocationsWorkstationClustersListOptions

Additional options for Workstations#projectsLocationsWorkstationClustersList.

ProjectsLocationsWorkstationClustersPatchOptions

Additional options for Workstations#projectsLocationsWorkstationClustersPatch.

ProjectsLocationsWorkstationClustersWorkstationConfigsCreateOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsCreate.

ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsDelete.

ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicy.

ProjectsLocationsWorkstationClustersWorkstationConfigsListOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsList.

ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsListUsable.

ProjectsLocationsWorkstationClustersWorkstationConfigsPatchOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsPatch.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreate.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDelete.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicy.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsList.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsable.

ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchOptions

Additional options for Workstations#projectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatch.

ReadinessCheck

A readiness check to be performed on a workstation.

SetIamPolicyRequest

Request message for SetIamPolicy method.

StartWorkstationRequest

Request message for StartWorkstation.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

StopWorkstationRequest

Request message for StopWorkstation.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Workstation

A single instance of a developer workstation with its own persistent storage.

WorkstationCluster

A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.

WorkstationConfig

A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.