workstations

package
v0.197.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package workstations provides access to the Cloud Workstations API.

For product documentation, see: https://cloud.google.com/workstations

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/workstations/v1"
...
ctx := context.Background()
workstationsService, err := workstations.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

workstationsService, err := workstations.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
workstationsService, err := workstations.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Accelerator added in v0.170.0

type Accelerator struct {
	// Count: Optional. Number of accelerator cards exposed to the instance.
	Count int64 `json:"count,omitempty"`
	// Type: Optional. Type of accelerator resource to attach to the instance, for
	// example, "nvidia-tesla-p100".
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Count") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Accelerator: An accelerator card attached to the instance.

func (Accelerator) MarshalJSON added in v0.170.0

func (s Accelerator) MarshalJSON() ([]byte, error)

type AuditConfig

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (AuditConfig) MarshalJSON

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (AuditLogConfig) MarshalJSON

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON

func (s Binding) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type Container

type Container struct {
	// Args: Optional. Arguments passed to the entrypoint.
	Args []string `json:"args,omitempty"`
	// Command: Optional. If set, overrides the default ENTRYPOINT specified by the
	// image.
	Command []string `json:"command,omitempty"`
	// Env: Optional. Environment variables passed to the container's entrypoint.
	Env map[string]string `json:"env,omitempty"`
	// Image: Optional. A Docker container image that defines a custom environment.
	// Cloud Workstations provides a number of preconfigured images
	// (https://cloud.google.com/workstations/docs/preconfigured-base-images), but
	// you can create your own custom container images
	// (https://cloud.google.com/workstations/docs/custom-container-images). If
	// using a private image, the `host.gceInstance.serviceAccount` field must be
	// specified in the workstation configuration. If using a custom container
	// image, the service account must have Artifact Registry Reader
	// (https://cloud.google.com/artifact-registry/docs/access-control#roles)
	// permission to pull the specified image. Otherwise, the image must be
	// publicly accessible.
	Image string `json:"image,omitempty"`
	// RunAsUser: Optional. If set, overrides the USER specified in the image with
	// the given uid.
	RunAsUser int64 `json:"runAsUser,omitempty"`
	// WorkingDir: Optional. If set, overrides the default DIR specified by the
	// image.
	WorkingDir string `json:"workingDir,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Args") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Container: A Docker container.

func (Container) MarshalJSON

func (s Container) MarshalJSON() ([]byte, error)

type CustomerEncryptionKey

type CustomerEncryptionKey struct {
	// KmsKey: Immutable. The name of the Google Cloud KMS encryption key. For
	// example,
	// "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
	// `. The key must be in the same region as the workstation configuration.
	KmsKey string `json:"kmsKey,omitempty"`
	// KmsKeyServiceAccount: Immutable. The service account to use with the
	// specified KMS key. We recommend that you use a separate service account and
	// follow KMS best practices. For more information, see Separation of duties
	// (https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms
	// keys add-iam-policy-binding` `--member`
	// (https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
	KmsKeyServiceAccount string `json:"kmsKeyServiceAccount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKey") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KmsKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://cloud.google.com/kms/docs/separation-of-duties).

func (CustomerEncryptionKey) MarshalJSON

func (s CustomerEncryptionKey) MarshalJSON() ([]byte, error)

type DomainConfig added in v0.155.0

type DomainConfig struct {
	// Domain: Immutable. Domain used by Workstations for HTTP ingress.
	Domain string `json:"domain,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Domain") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Domain") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DomainConfig: Configuration options for a custom domain.

func (DomainConfig) MarshalJSON added in v0.155.0

func (s DomainConfig) MarshalJSON() ([]byte, error)

type EphemeralDirectory added in v0.170.0

type EphemeralDirectory struct {
	// GcePd: An EphemeralDirectory backed by a Compute Engine persistent disk.
	GcePd *GcePersistentDisk `json:"gcePd,omitempty"`
	// MountPath: Required. Location of this directory in the running workstation.
	MountPath string `json:"mountPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcePd") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcePd") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (EphemeralDirectory) MarshalJSON added in v0.170.0

func (s EphemeralDirectory) MarshalJSON() ([]byte, error)

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (Expr) MarshalJSON

func (s Expr) MarshalJSON() ([]byte, error)

type GceConfidentialInstanceConfig

type GceConfidentialInstanceConfig struct {
	// EnableConfidentialCompute: Optional. Whether the instance has confidential
	// compute enabled.
	EnableConfidentialCompute bool `json:"enableConfidentialCompute,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableConfidentialCompute")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableConfidentialCompute") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GceConfidentialInstanceConfig: A set of Compute Engine Confidential VM instance options.

func (GceConfidentialInstanceConfig) MarshalJSON

func (s GceConfidentialInstanceConfig) MarshalJSON() ([]byte, error)

type GceInstance

type GceInstance struct {
	// Accelerators: Optional. A list of the type and count of accelerator cards
	// attached to the instance.
	Accelerators []*Accelerator `json:"accelerators,omitempty"`
	// BootDiskSizeGb: Optional. The size of the boot disk for the VM in gigabytes
	// (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
	BootDiskSizeGb int64 `json:"bootDiskSizeGb,omitempty"`
	// ConfidentialInstanceConfig: Optional. A set of Compute Engine Confidential
	// VM instance options.
	ConfidentialInstanceConfig *GceConfidentialInstanceConfig `json:"confidentialInstanceConfig,omitempty"`
	// DisablePublicIpAddresses: Optional. When set to true, disables public IP
	// addresses for VMs. If you disable public IP addresses, you must set up
	// Private Google Access or Cloud NAT on your network. If you use Private
	// Google Access and you use `private.googleapis.com` or
	// `restricted.googleapis.com` for Container Registry and Artifact Registry,
	// make sure that you set up DNS records for domains `*.gcr.io` and
	// `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
	DisablePublicIpAddresses bool `json:"disablePublicIpAddresses,omitempty"`
	// DisableSsh: Optional. Whether to disable SSH access to the VM.
	DisableSsh bool `json:"disableSsh,omitempty"`
	// EnableNestedVirtualization: Optional. Whether to enable nested
	// virtualization on Cloud Workstations VMs created using this workstation
	// configuration. Defaults to false. Nested virtualization lets you run virtual
	// machine (VM) instances inside your workstation. Before enabling nested
	// virtualization, consider the following important considerations. Cloud
	// Workstations instances are subject to the same restrictions as Compute
	// Engine instances
	// (https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions):
	// * **Organization policy**: projects, folders, or organizations may be
	// restricted from creating nested VMs if the **Disable VM nested
	// virtualization** constraint is enforced in the organization policy. For more
	// information, see the Compute Engine section, Checking whether nested
	// virtualization is allowed
	// (https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed).
	// * **Performance**: nested VMs might experience a 10% or greater decrease in
	// performance for workloads that are CPU-bound and possibly greater than a 10%
	// decrease for workloads that are input/output bound. * **Machine Type**:
	// nested virtualization can only be enabled on workstation configurations that
	// specify a machine_type in the N1 or N2 machine series.
	EnableNestedVirtualization bool `json:"enableNestedVirtualization,omitempty"`
	// MachineType: Optional. The type of machine to use for VM instances—for
	// example, "e2-standard-4". For more information about machine types that
	// Cloud Workstations supports, see the list of available machine types
	// (https://cloud.google.com/workstations/docs/available-machine-types).
	MachineType string `json:"machineType,omitempty"`
	// PoolSize: Optional. The number of VMs that the system should keep idle so
	// that new workstations can be started quickly for new users. Defaults to `0`
	// in the API.
	PoolSize int64 `json:"poolSize,omitempty"`
	// PooledInstances: Output only. Number of instances currently available in the
	// pool for faster workstation startup.
	PooledInstances int64 `json:"pooledInstances,omitempty"`
	// ServiceAccount: Optional. The email address of the service account for Cloud
	// Workstations VMs created with this configuration. When specified, be sure
	// that the service account has `logging.logEntries.create` and
	// `monitoring.timeSeries.create` permissions on the project so it can write
	// logs out to Cloud Logging. If using a custom container image, the service
	// account must have Artifact Registry Reader
	// (https://cloud.google.com/artifact-registry/docs/access-control#roles)
	// permission to pull the specified image. If you as the administrator want to
	// be able to `ssh` into the underlying VM, you need to set this value to a
	// service account for which you have the `iam.serviceAccounts.actAs`
	// permission. Conversely, if you don't want anyone to be able to `ssh` into
	// the underlying VM, use a service account where no one has that permission.
	// If not set, VMs run with a service account provided by the Cloud
	// Workstations service, and the image must be publicly accessible.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// ServiceAccountScopes: Optional. Scopes to grant to the service_account. When
	// specified, users of workstations under this configuration must have
	// `iam.serviceAccounts.actAs` on the service account.
	ServiceAccountScopes []string `json:"serviceAccountScopes,omitempty"`
	// ShieldedInstanceConfig: Optional. A set of Compute Engine Shielded instance
	// options.
	ShieldedInstanceConfig *GceShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"`
	// Tags: Optional. Network tags to add to the Compute Engine VMs backing the
	// workstations. This option applies network tags
	// (https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created
	// with this configuration. These network tags enable the creation of firewall
	// rules (https://cloud.google.com/workstations/docs/configure-firewall-rules).
	Tags []string `json:"tags,omitempty"`
	// VmTags: Optional. Resource manager tags to be bound to this instance. Tag
	// keys and values have the same definition as resource manager tags
	// (https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys
	// must be in the format `tagKeys/{tag_key_id}`, and values are in the format
	// `tagValues/456`.
	VmTags map[string]string `json:"vmTags,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Accelerators") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Accelerators") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GceInstance: A runtime using a Compute Engine instance.

func (GceInstance) MarshalJSON

func (s GceInstance) MarshalJSON() ([]byte, error)

type GcePersistentDisk added in v0.170.0

type GcePersistentDisk struct {
	// DiskType: Optional. Type of the disk to use. Defaults to "pd-standard".
	DiskType string `json:"diskType,omitempty"`
	// ReadOnly: Optional. Whether the disk is read only. If true, the disk may be
	// shared by multiple VMs and source_snapshot must be set.
	ReadOnly bool `json:"readOnly,omitempty"`
	// SourceImage: Optional. Name of the disk image to use as the source for the
	// disk. Must be empty if source_snapshot is set. Updating source_image will
	// update content in the ephemeral directory after the workstation is
	// restarted. This field is mutable.
	SourceImage string `json:"sourceImage,omitempty"`
	// SourceSnapshot: Optional. Name of the snapshot to use as the source for the
	// disk. Must be empty if source_image is set. Must be empty if read_only is
	// false. Updating source_snapshot will update content in the ephemeral
	// directory after the workstation is restarted. This field is mutable.
	SourceSnapshot string `json:"sourceSnapshot,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiskType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DiskType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GcePersistentDisk: An EphemeralDirectory is backed by a Compute Engine persistent disk.

func (GcePersistentDisk) MarshalJSON added in v0.170.0

func (s GcePersistentDisk) MarshalJSON() ([]byte, error)

type GceRegionalPersistentDisk

type GceRegionalPersistentDisk struct {
	// DiskType: Optional. The type of the persistent disk
	// (https://cloud.google.com/compute/docs/disks#disk-types) for the home
	// directory. Defaults to "pd-standard".
	DiskType string `json:"diskType,omitempty"`
	// FsType: Optional. Type of file system that the disk should be formatted
	// with. The workstation image must support this file system type. Must be
	// empty if source_snapshot is set. Defaults to "ext4".
	FsType string `json:"fsType,omitempty"`
	// ReclaimPolicy: Optional. Whether the persistent disk should be deleted when
	// the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults
	// to `DELETE`.
	//
	// Possible values:
	//   "RECLAIM_POLICY_UNSPECIFIED" - Do not use.
	//   "DELETE" - Delete the persistent disk when deleting the workstation.
	//   "RETAIN" - Keep the persistent disk when deleting the workstation. An
	// administrator must manually delete the disk.
	ReclaimPolicy string `json:"reclaimPolicy,omitempty"`
	// SizeGb: Optional. The GB capacity of a persistent home directory for each
	// workstation created with this configuration. Must be empty if
	// source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or
	// `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be
	// "pd-balanced" or "pd-ssd".
	SizeGb int64 `json:"sizeGb,omitempty"`
	// SourceSnapshot: Optional. Name of the snapshot to use as the source for the
	// disk. If set, size_gb and fs_type must be empty.
	SourceSnapshot string `json:"sourceSnapshot,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiskType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DiskType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://cloud.google.com/compute/docs/disks/persistent-disks) 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.

func (GceRegionalPersistentDisk) MarshalJSON

func (s GceRegionalPersistentDisk) MarshalJSON() ([]byte, error)

type GceShieldedInstanceConfig

type GceShieldedInstanceConfig struct {
	// EnableIntegrityMonitoring: Optional. Whether the instance has integrity
	// monitoring enabled.
	EnableIntegrityMonitoring bool `json:"enableIntegrityMonitoring,omitempty"`
	// EnableSecureBoot: Optional. Whether the instance has Secure Boot enabled.
	EnableSecureBoot bool `json:"enableSecureBoot,omitempty"`
	// EnableVtpm: Optional. Whether the instance has the vTPM enabled.
	EnableVtpm bool `json:"enableVtpm,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableIntegrityMonitoring")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableIntegrityMonitoring") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GceShieldedInstanceConfig: A set of Compute Engine Shielded instance options.

func (GceShieldedInstanceConfig) MarshalJSON

func (s GceShieldedInstanceConfig) MarshalJSON() ([]byte, error)

type GenerateAccessTokenRequest

type GenerateAccessTokenRequest struct {
	// ExpireTime: Desired expiration time of the access token. This value must be
	// at most 24 hours in the future. If a value is not specified, the token's
	// expiration time will be set to a default value of 1 hour in the future.
	ExpireTime string `json:"expireTime,omitempty"`
	// Port: Optional. Port for which the access token should be generated. If
	// specified, the generated access token grants access only to the specified
	// port of the workstation. If specified, values must be within the range [1 -
	// 65535]. If not specified, the generated access token grants access to all
	// ports of the workstation.
	Port int64 `json:"port,omitempty"`
	// Ttl: Desired lifetime duration of the access token. This value must be at
	// most 24 hours. If a value is not specified, the token's lifetime will be set
	// to a default value of 1 hour.
	Ttl string `json:"ttl,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpireTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpireTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAccessTokenRequest: Request message for GenerateAccessToken.

func (GenerateAccessTokenRequest) MarshalJSON

func (s GenerateAccessTokenRequest) MarshalJSON() ([]byte, error)

type GenerateAccessTokenResponse

type GenerateAccessTokenResponse struct {
	// AccessToken: The generated bearer access token. To use this token, include
	// it in an Authorization header of an HTTP request sent to the associated
	// workstation's hostname—for example, `Authorization: Bearer `.
	AccessToken string `json:"accessToken,omitempty"`
	// ExpireTime: Time at which the generated token will expire.
	ExpireTime string `json:"expireTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAccessTokenResponse: Response message for GenerateAccessToken.

func (GenerateAccessTokenResponse) MarshalJSON

func (s GenerateAccessTokenResponse) MarshalJSON() ([]byte, error)

type GoogleProtobufEmpty

type GoogleProtobufEmpty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

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); }

type Host

type Host struct {
	// GceInstance: Specifies a Compute Engine instance as the host.
	GceInstance *GceInstance `json:"gceInstance,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GceInstance") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GceInstance") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Host: Runtime host for a workstation.

func (Host) MarshalJSON

func (s Host) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListUsableWorkstationConfigsResponse

type ListUsableWorkstationConfigsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Unreachable resources.
	Unreachable []string `json:"unreachable,omitempty"`
	// WorkstationConfigs: The requested configs.
	WorkstationConfigs []*WorkstationConfig `json:"workstationConfigs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListUsableWorkstationConfigsResponse: Response message for ListUsableWorkstationConfigs.

func (ListUsableWorkstationConfigsResponse) MarshalJSON

func (s ListUsableWorkstationConfigsResponse) MarshalJSON() ([]byte, error)

type ListUsableWorkstationsResponse

type ListUsableWorkstationsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Unreachable resources.
	Unreachable []string `json:"unreachable,omitempty"`
	// Workstations: The requested workstations.
	Workstations []*Workstation `json:"workstations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListUsableWorkstationsResponse: Response message for ListUsableWorkstations.

func (ListUsableWorkstationsResponse) MarshalJSON

func (s ListUsableWorkstationsResponse) MarshalJSON() ([]byte, error)

type ListWorkstationClustersResponse

type ListWorkstationClustersResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Unreachable resources.
	Unreachable []string `json:"unreachable,omitempty"`
	// WorkstationClusters: The requested workstation clusters.
	WorkstationClusters []*WorkstationCluster `json:"workstationClusters,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListWorkstationClustersResponse: Response message for ListWorkstationClusters.

func (ListWorkstationClustersResponse) MarshalJSON

func (s ListWorkstationClustersResponse) MarshalJSON() ([]byte, error)

type ListWorkstationConfigsResponse

type ListWorkstationConfigsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Unreachable resources.
	Unreachable []string `json:"unreachable,omitempty"`
	// WorkstationConfigs: The requested configs.
	WorkstationConfigs []*WorkstationConfig `json:"workstationConfigs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListWorkstationConfigsResponse: Response message for ListWorkstationConfigs.

func (ListWorkstationConfigsResponse) MarshalJSON

func (s ListWorkstationConfigsResponse) MarshalJSON() ([]byte, error)

type ListWorkstationsResponse

type ListWorkstationsResponse struct {
	// NextPageToken: Optional. Token to retrieve the next page of results, or
	// empty if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Optional. Unreachable resources.
	Unreachable []string `json:"unreachable,omitempty"`
	// Workstations: The requested workstations.
	Workstations []*Workstation `json:"workstations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListWorkstationsResponse: Response message for ListWorkstations.

func (ListWorkstationsResponse) MarshalJSON

func (s ListWorkstationsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. Time that the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. Time that the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Metadata for long-running operations.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type PersistentDirectory

type PersistentDirectory struct {
	// GcePd: A PersistentDirectory backed by a Compute Engine persistent disk.
	GcePd *GceRegionalPersistentDisk `json:"gcePd,omitempty"`
	// MountPath: Optional. Location of this directory in the running workstation.
	MountPath string `json:"mountPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcePd") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcePd") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PersistentDirectory: A directory to persist across workstation sessions.

func (PersistentDirectory) MarshalJSON

func (s PersistentDirectory) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://cloud.google.com/iam/help/conditions/resource-policies). **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: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer 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 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) MarshalJSON() ([]byte, error)

type PortRange added in v0.189.0

type PortRange struct {
	// First: Required. Starting port number for the current range of ports. Valid
	// ports are 22, 80, and ports within the range 1024-65535.
	First int64 `json:"first,omitempty"`
	// Last: Required. Ending port number for the current range of ports. Valid
	// ports are 22, 80, and ports within the range 1024-65535.
	Last int64 `json:"last,omitempty"`
	// ForceSendFields is a list of field names (e.g. "First") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "First") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PortRange: A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.

func (PortRange) MarshalJSON added in v0.189.0

func (s PortRange) MarshalJSON() ([]byte, error)

type PrivateClusterConfig

type PrivateClusterConfig struct {
	// AllowedProjects: Optional. Additional projects that are allowed to attach to
	// the workstation cluster's service attachment. By default, the workstation
	// cluster's project and the VPC host project (if different) are allowed.
	AllowedProjects []string `json:"allowedProjects,omitempty"`
	// ClusterHostname: Output only. Hostname for the workstation cluster. This
	// field will be populated only when private endpoint is enabled. To access
	// workstations in the workstation cluster, create a new DNS zone mapping this
	// domain name to an internal IP address and a forwarding rule mapping that
	// address to the service attachment.
	ClusterHostname string `json:"clusterHostname,omitempty"`
	// EnablePrivateEndpoint: Immutable. Whether Workstations endpoint is private.
	EnablePrivateEndpoint bool `json:"enablePrivateEndpoint,omitempty"`
	// ServiceAttachmentUri: Output only. Service attachment URI for the
	// workstation cluster. The service attachemnt is created when private endpoint
	// is enabled. To access workstations in the workstation cluster, configure
	// access to the managed service using Private Service Connect
	// (https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
	ServiceAttachmentUri string `json:"serviceAttachmentUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedProjects") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedProjects") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PrivateClusterConfig: Configuration options for private workstation clusters.

func (PrivateClusterConfig) MarshalJSON

func (s PrivateClusterConfig) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

Do executes the "workstations.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

Do executes the "workstations.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "workstations.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

Do executes the "workstations.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "workstations.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "workstations.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: 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`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: 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`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: 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.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

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

- name: The name of the operation's parent resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Operations *ProjectsLocationsOperationsService

	WorkstationClusters *ProjectsLocationsWorkstationClustersService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsLocationsWorkstationClustersCreateCall

type ProjectsLocationsWorkstationClustersCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersCreateCall) Do

Do executes the "workstations.projects.locations.workstationClusters.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersCreateCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

func (*ProjectsLocationsWorkstationClustersCreateCall) WorkstationClusterId

WorkstationClusterId sets the optional parameter "workstationClusterId": Required. ID to use for the workstation cluster.

type ProjectsLocationsWorkstationClustersDeleteCall

type ProjectsLocationsWorkstationClustersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersDeleteCall) Do

Do executes the "workstations.projects.locations.workstationClusters.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersDeleteCall) Etag

Etag sets the optional parameter "etag": If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.

func (*ProjectsLocationsWorkstationClustersDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersDeleteCall) Force

Force sets the optional parameter "force": If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.

func (*ProjectsLocationsWorkstationClustersDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersDeleteCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not apply it.

type ProjectsLocationsWorkstationClustersGetCall

type ProjectsLocationsWorkstationClustersGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersGetCall) Do

Do executes the "workstations.projects.locations.workstationClusters.get" call. Any non-2xx status code is an error. Response headers are in either *WorkstationCluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsWorkstationClustersListCall

type ProjectsLocationsWorkstationClustersListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersListCall) Do

Do executes the "workstations.projects.locations.workstationClusters.list" call. Any non-2xx status code is an error. Response headers are in either *ListWorkstationClustersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersListCall) PageSize

PageSize sets the optional parameter "pageSize": Maximum number of items to return.

func (*ProjectsLocationsWorkstationClustersListCall) PageToken

PageToken sets the optional parameter "pageToken": next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsWorkstationClustersListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsWorkstationClustersPatchCall

type ProjectsLocationsWorkstationClustersPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersPatchCall) AllowMissing

AllowMissing sets the optional parameter "allowMissing": If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.

func (*ProjectsLocationsWorkstationClustersPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersPatchCall) Do

Do executes the "workstations.projects.locations.workstationClusters.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Mask that specifies which fields in the workstation cluster should be updated.

func (*ProjectsLocationsWorkstationClustersPatchCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

type ProjectsLocationsWorkstationClustersService

type ProjectsLocationsWorkstationClustersService struct {
	WorkstationConfigs *ProjectsLocationsWorkstationClustersWorkstationConfigsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsWorkstationClustersService

func NewProjectsLocationsWorkstationClustersService(s *Service) *ProjectsLocationsWorkstationClustersService

func (*ProjectsLocationsWorkstationClustersService) Create

Create: Creates a new workstation cluster.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersService) Delete

Delete: Deletes the specified workstation cluster.

- name: Name of the workstation cluster to delete.

func (*ProjectsLocationsWorkstationClustersService) Get

Get: Returns the requested workstation cluster.

- name: Name of the requested resource.

func (*ProjectsLocationsWorkstationClustersService) List

List: Returns all workstation clusters in the specified location.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersService) Patch

Patch: Updates an existing workstation cluster.

- name: Identifier. Full name of this workstation cluster.

type ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsCreateCall) WorkstationConfigId

WorkstationConfigId sets the optional parameter "workstationConfigId": Required. ID to use for the workstation configuration.

type ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Etag

Etag sets the optional parameter "etag": If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Force

Force sets the optional parameter "force": If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsDeleteCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

type ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.get" call. Any non-2xx status code is an error. Response headers are in either *WorkstationConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsGetIamPolicyCall) OptionsRequestedPolicyVersion

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsWorkstationClustersWorkstationConfigsListCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.list" call. Any non-2xx status code is an error. Response headers are in either *ListWorkstationConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) PageSize

PageSize sets the optional parameter "pageSize": Maximum number of items to return.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) PageToken

PageToken sets the optional parameter "pageToken": next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.listUsable" call. Any non-2xx status code is an error. Response headers are in either *ListUsableWorkstationConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) PageSize

PageSize sets the optional parameter "pageSize": Maximum number of items to return.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) PageToken

PageToken sets the optional parameter "pageToken": next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsListUsableCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) AllowMissing

AllowMissing sets the optional parameter "allowMissing": If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Mask specifying which fields in the workstation configuration should be updated.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsPatchCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

type ProjectsLocationsWorkstationClustersWorkstationConfigsService

type ProjectsLocationsWorkstationClustersWorkstationConfigsService struct {
	Workstations *ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) Create

Create: Creates a new workstation configuration.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) Delete

Delete: Deletes the specified workstation configuration.

- name: Name of the workstation configuration to delete.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) Get

Get: Returns the requested workstation configuration.

- name: Name of the requested resource.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) GetIamPolicy

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

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) List

List: Returns all workstation configurations in the specified cluster.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) ListUsable

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

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) Patch

Patch: Updates an existing workstation configuration.

- name: Identifier. Full name of this workstation configuration.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) SetIamPolicy

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

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsService) TestIamPermissions

TestIamPermissions: 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.

type ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsCreateCall) WorkstationId

WorkstationId sets the optional parameter "workstationId": Required. ID to use for the workstation.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) Etag

Etag sets the optional parameter "etag": If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsDeleteCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken" call. Any non-2xx status code is an error. Response headers are in either *GenerateAccessTokenResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGenerateAccessTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.get" call. Any non-2xx status code is an error. Response headers are in either *Workstation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsGetIamPolicyCall) OptionsRequestedPolicyVersion

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list" call. Any non-2xx status code is an error. Response headers are in either *ListWorkstationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) PageSize

PageSize sets the optional parameter "pageSize": Maximum number of items to return.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) PageToken

PageToken sets the optional parameter "pageToken": next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable" call. Any non-2xx status code is an error. Response headers are in either *ListUsableWorkstationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) PageSize

PageSize sets the optional parameter "pageSize": Maximum number of items to return.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) PageToken

PageToken sets the optional parameter "pageToken": next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsListUsableCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) AllowMissing

AllowMissing sets the optional parameter "allowMissing": If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Mask specifying which fields in the workstation configuration should be updated.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsPatchCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If set, validate the request and preview the review, but do not actually apply it.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Create

Create: Creates a new workstation.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Delete

Delete: Deletes the specified workstation.

- name: Name of the workstation to delete.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) GenerateAccessToken

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

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

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Get

Get: Returns the requested workstation.

- name: Name of the requested resource.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) GetIamPolicy

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

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) List

List: Returns all Workstations using the specified workstation configuration.

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) ListUsable

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

- parent: Parent resource name.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Patch

Patch: Updates an existing workstation.

- name: Identifier. Full name of this workstation.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) SetIamPolicy

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

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Start

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

- name: Name of the workstation to start.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) Stop

Stop: Stops running a workstation, reducing costs.

- name: Name of the workstation to stop.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsService) TestIamPermissions

TestIamPermissions: 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.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.start" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStartCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsStopCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall

type ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall) Do

Do executes the "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstationsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ReadinessCheck

type ReadinessCheck struct {
	// Path: Optional. Path to which the request should be sent.
	Path string `json:"path,omitempty"`
	// Port: Optional. Port to which the request should be sent.
	Port int64 `json:"port,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Path") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Path") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReadinessCheck: A readiness check to be performed on a workstation.

func (ReadinessCheck) MarshalJSON

func (s ReadinessCheck) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type StartWorkstationRequest

type StartWorkstationRequest struct {
	// Etag: Optional. If set, the request will be rejected if the latest version
	// of the workstation on the server does not have this ETag.
	Etag string `json:"etag,omitempty"`
	// ValidateOnly: Optional. If set, validate the request and preview the review,
	// but do not actually apply it.
	ValidateOnly bool `json:"validateOnly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StartWorkstationRequest: Request message for StartWorkstation.

func (StartWorkstationRequest) MarshalJSON

func (s StartWorkstationRequest) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://github.com/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 (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type StopWorkstationRequest

type StopWorkstationRequest struct {
	// Etag: Optional. If set, the request will be rejected if the latest version
	// of the workstation on the server does not have this ETag.
	Etag string `json:"etag,omitempty"`
	// ValidateOnly: Optional. If set, validate the request and preview the review,
	// but do not actually apply it.
	ValidateOnly bool `json:"validateOnly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StopWorkstationRequest: Request message for StopWorkstation.

func (StopWorkstationRequest) MarshalJSON

func (s StopWorkstationRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type Workstation

type Workstation struct {
	// Annotations: Optional. Client-specified annotations.
	Annotations map[string]string `json:"annotations,omitempty"`
	// CreateTime: Output only. Time when this workstation was created.
	CreateTime string `json:"createTime,omitempty"`
	// DeleteTime: Output only. Time when this workstation was soft-deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// DisplayName: Optional. Human-readable name for this workstation.
	DisplayName string `json:"displayName,omitempty"`
	// Env: Optional. Environment variables passed to the workstation container's
	// entrypoint.
	Env map[string]string `json:"env,omitempty"`
	// Etag: Optional. Checksum computed by the server. May be sent on update and
	// delete requests to make sure that the client has an up-to-date value before
	// proceeding.
	Etag string `json:"etag,omitempty"`
	// Host: Output only. Host to which clients can send HTTPS traffic that will be
	// received by the workstation. Authorized traffic will be received to the
	// workstation as HTTP on port 80. To send traffic to a different port, clients
	// may prefix the host with the destination port in the format `{port}-{host}`.
	Host string `json:"host,omitempty"`
	// KmsKey: Output only. The name of the Google Cloud KMS encryption key used to
	// encrypt this workstation. The KMS key can only be configured in the
	// WorkstationConfig. The expected format is
	// `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
	KmsKey string `json:"kmsKey,omitempty"`
	// Labels: Optional. Labels
	// (https://cloud.google.com/workstations/docs/label-resources) that are
	// applied to the workstation and that are also propagated to the underlying
	// Compute Engine resources.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. Full name of this workstation.
	Name string `json:"name,omitempty"`
	// Reconciling: Output only. Indicates whether this workstation is currently
	// being updated to match its intended state.
	Reconciling bool `json:"reconciling,omitempty"`
	// StartTime: Output only. Time when this workstation was most recently
	// successfully started, regardless of the workstation's initial state.
	StartTime string `json:"startTime,omitempty"`
	// State: Output only. Current state of the workstation.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Do not use.
	//   "STATE_STARTING" - The workstation is not yet ready to accept requests
	// from users but will be soon.
	//   "STATE_RUNNING" - The workstation is ready to accept requests from users.
	//   "STATE_STOPPING" - The workstation is being stopped.
	//   "STATE_STOPPED" - The workstation is stopped and will not be able to
	// receive requests until it is started.
	State string `json:"state,omitempty"`
	// Uid: Output only. A system-assigned unique identifier for this workstation.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. Time when this workstation was most recently
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Annotations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Workstation) MarshalJSON

func (s Workstation) MarshalJSON() ([]byte, error)

type WorkstationCluster

type WorkstationCluster struct {
	// Annotations: Optional. Client-specified annotations.
	Annotations map[string]string `json:"annotations,omitempty"`
	// Conditions: Output only. Status conditions describing the workstation
	// cluster's current state.
	Conditions []*Status `json:"conditions,omitempty"`
	// ControlPlaneIp: Output only. The private IP address of the control plane for
	// this workstation cluster. Workstation VMs need access to this IP address to
	// work with the service, so make sure that your firewall rules allow egress
	// from the workstation VMs to this address.
	ControlPlaneIp string `json:"controlPlaneIp,omitempty"`
	// CreateTime: Output only. Time when this workstation cluster was created.
	CreateTime string `json:"createTime,omitempty"`
	// Degraded: Output only. Whether this workstation cluster is in degraded mode,
	// in which case it may require user action to restore full functionality.
	// Details can be found in conditions.
	Degraded bool `json:"degraded,omitempty"`
	// DeleteTime: Output only. Time when this workstation cluster was
	// soft-deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// DisplayName: Optional. Human-readable name for this workstation cluster.
	DisplayName string `json:"displayName,omitempty"`
	// DomainConfig: Optional. Configuration options for a custom domain.
	DomainConfig *DomainConfig `json:"domainConfig,omitempty"`
	// Etag: Optional. Checksum computed by the server. May be sent on update and
	// delete requests to make sure that the client has an up-to-date value before
	// proceeding.
	Etag string `json:"etag,omitempty"`
	// Labels: Optional. Labels
	// (https://cloud.google.com/workstations/docs/label-resources) that are
	// applied to the workstation cluster and that are also propagated to the
	// underlying Compute Engine resources.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. Full name of this workstation cluster.
	Name string `json:"name,omitempty"`
	// Network: Immutable. Name of the Compute Engine network in which instances
	// associated with this workstation cluster will be created.
	Network string `json:"network,omitempty"`
	// PrivateClusterConfig: Optional. Configuration for private workstation
	// cluster.
	PrivateClusterConfig *PrivateClusterConfig `json:"privateClusterConfig,omitempty"`
	// Reconciling: Output only. Indicates whether this workstation cluster is
	// currently being updated to match its intended state.
	Reconciling bool `json:"reconciling,omitempty"`
	// Subnetwork: Immutable. Name of the Compute Engine subnetwork in which
	// instances associated with this workstation cluster will be created. Must be
	// part of the subnetwork specified for this workstation cluster.
	Subnetwork string `json:"subnetwork,omitempty"`
	// Uid: Output only. A system-assigned unique identifier for this workstation
	// cluster.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. Time when this workstation cluster was most
	// recently updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Annotations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (WorkstationCluster) MarshalJSON

func (s WorkstationCluster) MarshalJSON() ([]byte, error)

type WorkstationConfig

type WorkstationConfig struct {
	// AllowedPorts: Optional. A list of PortRanges specifying single ports or
	// ranges of ports that are externally accessible in the workstation. Allowed
	// ports must be one of 22, 80, or within range 1024-65535. If not specified
	// defaults to ports 22, 80, and ports 1024-65535.
	AllowedPorts []*PortRange `json:"allowedPorts,omitempty"`
	// Annotations: Optional. Client-specified annotations.
	Annotations map[string]string `json:"annotations,omitempty"`
	// Conditions: Output only. Status conditions describing the current resource
	// state.
	Conditions []*Status `json:"conditions,omitempty"`
	// Container: Optional. Container that runs upon startup for each workstation
	// using this workstation configuration.
	Container *Container `json:"container,omitempty"`
	// CreateTime: Output only. Time when this workstation configuration was
	// created.
	CreateTime string `json:"createTime,omitempty"`
	// Degraded: Output only. Whether this resource is degraded, in which case it
	// may require user action to restore full functionality. See also the
	// conditions field.
	Degraded bool `json:"degraded,omitempty"`
	// DeleteTime: Output only. Time when this workstation configuration was
	// soft-deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// DisableTcpConnections: Optional. Disables support for plain TCP connections
	// in the workstation. By default the service supports TCP connections through
	// a websocket relay. Setting this option to true disables that relay, which
	// prevents the usage of services that require plain TCP connections, such as
	// SSH. When enabled, all communication must occur over HTTPS or WSS.
	DisableTcpConnections bool `json:"disableTcpConnections,omitempty"`
	// DisplayName: Optional. Human-readable name for this workstation
	// configuration.
	DisplayName string `json:"displayName,omitempty"`
	// EnableAuditAgent: Optional. Whether to enable Linux `auditd` logging on the
	// workstation. When enabled, a service_account must also be specified that has
	// `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the
	// project. Operating system audit logging is distinct from Cloud Audit Logs
	// (https://cloud.google.com/workstations/docs/audit-logging) and Container
	// output logging
	// (http://cloud/workstations/docs/container-output-logging#overview).
	// Operating system audit logs are available in the Cloud Logging
	// (https://cloud.google.com/logging/docs) console by querying:
	// resource.type="gce_instance" log_name:"/logs/linux-auditd"
	EnableAuditAgent bool `json:"enableAuditAgent,omitempty"`
	// EncryptionKey: Immutable. Encrypts resources of this workstation
	// configuration using a customer-managed encryption key (CMEK). If specified,
	// the boot disk of the Compute Engine instance and the persistent disk are
	// encrypted using this encryption key. If this field is not set, the disks are
	// encrypted using a generated key. Customer-managed encryption keys do not
	// protect disk metadata. If the customer-managed encryption key is rotated,
	// when the workstation instance is stopped, the system attempts to recreate
	// the persistent disk with the new version of the key. Be sure to keep older
	// versions of the key until the persistent disk is recreated. Otherwise, data
	// on the persistent disk might be lost. If the encryption key is revoked, the
	// workstation session automatically stops within 7 hours. Immutable after the
	// workstation configuration is created.
	EncryptionKey *CustomerEncryptionKey `json:"encryptionKey,omitempty"`
	// EphemeralDirectories: Optional. Ephemeral directories which won't persist
	// across workstation sessions.
	EphemeralDirectories []*EphemeralDirectory `json:"ephemeralDirectories,omitempty"`
	// Etag: Optional. Checksum computed by the server. May be sent on update and
	// delete requests to make sure that the client has an up-to-date value before
	// proceeding.
	Etag string `json:"etag,omitempty"`
	// GrantWorkstationAdminRoleOnCreate: Optional. Grant creator of a workstation
	// `roles/workstations.policyAdmin` role along with `roles/workstations.user`
	// role on the workstation created by them. This allows workstation users to
	// share access to either their entire workstation, or individual ports.
	// Defaults to false.
	GrantWorkstationAdminRoleOnCreate bool `json:"grantWorkstationAdminRoleOnCreate,omitempty"`
	// Host: Optional. Runtime host for the workstation.
	Host *Host `json:"host,omitempty"`
	// IdleTimeout: Optional. Number of seconds to wait before automatically
	// stopping a workstation after it last received user traffic. A value of
	// "0s" indicates that Cloud Workstations VMs created with this configuration
	// should never time out due to idleness. Provide duration
	// (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration)
	// terminated by `s` for seconds—for example, "7200s" (2 hours). The
	// default is "1200s" (20 minutes).
	IdleTimeout string `json:"idleTimeout,omitempty"`
	// Labels: Optional. Labels
	// (https://cloud.google.com/workstations/docs/label-resources) that are
	// applied to the workstation configuration and that are also propagated to the
	// underlying Compute Engine resources.
	Labels map[string]string `json:"labels,omitempty"`
	// MaxUsableWorkstations: Optional. Maximum number of workstations under this
	// config a user can have `workstations.workstation.use` permission on. Only
	// enforced on CreateWorkstation API calls on the user issuing the API request.
	// Can be overridden by: - granting a user
	// workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission,
	// or - having a user with that permission create a workstation and granting
	// another user `workstations.workstation.use` permission on that workstation.
	// If not specified defaults to 0 which indicates unlimited.
	MaxUsableWorkstations int64 `json:"maxUsableWorkstations,omitempty"`
	// Name: Identifier. Full name of this workstation configuration.
	Name string `json:"name,omitempty"`
	// PersistentDirectories: Optional. Directories to persist across workstation
	// sessions.
	PersistentDirectories []*PersistentDirectory `json:"persistentDirectories,omitempty"`
	// ReadinessChecks: Optional. Readiness checks to perform when starting a
	// workstation using this workstation configuration. Mark a workstation as
	// running only after all specified readiness checks return 200 status codes.
	ReadinessChecks []*ReadinessCheck `json:"readinessChecks,omitempty"`
	// Reconciling: Output only. Indicates whether this workstation configuration
	// is currently being updated to match its intended state.
	Reconciling bool `json:"reconciling,omitempty"`
	// ReplicaZones: Optional. Immutable. Specifies the zones used to replicate the
	// VM and disk resources within the region. If set, exactly two zones within
	// the workstation cluster's region must be specified—for example,
	// `['us-central1-a', 'us-central1-f']`. If this field is empty, two default
	// zones within the region are used. Immutable after the workstation
	// configuration is created.
	ReplicaZones []string `json:"replicaZones,omitempty"`
	// RunningTimeout: Optional. Number of seconds that a workstation can run until
	// it is automatically shut down. We recommend that workstations be shut down
	// daily to reduce costs and so that security updates can be applied upon
	// restart. The idle_timeout and running_timeout fields are independent of each
	// other. Note that the running_timeout field shuts down VMs after the
	// specified time, regardless of whether or not the VMs are idle. Provide
	// duration terminated by `s` for seconds—for example, "54000s" (15 hours).
	// Defaults to "43200s" (12 hours). A value of "0s" indicates that
	// workstations using this configuration should never time out. If
	// encryption_key is set, it must be greater than "0s" and less than
	// "86400s" (24 hours). Warning: A value of "0s" indicates that Cloud
	// Workstations VMs created with this configuration have no maximum running
	// time. This is strongly discouraged because you incur costs and will not pick
	// up security updates.
	RunningTimeout string `json:"runningTimeout,omitempty"`
	// Uid: Output only. A system-assigned unique identifier for this workstation
	// configuration.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. Time when this workstation configuration was most
	// recently updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AllowedPorts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedPorts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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) (https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.

func (WorkstationConfig) MarshalJSON

func (s WorkstationConfig) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL