notebooks

package
v0.207.0 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package notebooks provides access to the Notebooks API.

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

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/notebooks/v1"
...
ctx := context.Background()
notebooksService, err := notebooks.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: 

notebooksService, err := notebooks.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, ...)
notebooksService, err := notebooks.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 AcceleratorConfig 

type AcceleratorConfig struct {
	// CoreCount: Count of cores of this accelerator.
	CoreCount int64 `json:"coreCount,omitempty,string"`
	// Type: Type of this accelerator.
	//
	// Possible values:
	//   "ACCELERATOR_TYPE_UNSPECIFIED" - Accelerator type is not specified.
	//   "NVIDIA_TESLA_K80" - Accelerator type is Nvidia Tesla K80.
	//   "NVIDIA_TESLA_P100" - Accelerator type is Nvidia Tesla P100.
	//   "NVIDIA_TESLA_V100" - Accelerator type is Nvidia Tesla V100.
	//   "NVIDIA_TESLA_P4" - Accelerator type is Nvidia Tesla P4.
	//   "NVIDIA_TESLA_T4" - Accelerator type is Nvidia Tesla T4.
	//   "NVIDIA_TESLA_A100" - Accelerator type is Nvidia Tesla A100.
	//   "NVIDIA_L4" - Accelerator type is Nvidia Tesla L4.
	//   "NVIDIA_A100_80GB" - Accelerator type is Nvidia Tesla A100 80GB.
	//   "NVIDIA_TESLA_T4_VWS" - Accelerator type is NVIDIA Tesla T4 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P100_VWS" - Accelerator type is NVIDIA Tesla P100 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P4_VWS" - Accelerator type is NVIDIA Tesla P4 Virtual
	// Workstations.
	//   "NVIDIA_H100_80GB" - Accelerator type is NVIDIA H100 80GB.
	//   "NVIDIA_H100_MEGA_80GB" - Accelerator type is NVIDIA H100 Mega 80GB.
	//   "TPU_V2" - (Coming soon) Accelerator type is TPU V2.
	//   "TPU_V3" - (Coming soon) Accelerator type is TPU V3.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CoreCount") 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. "CoreCount") 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:"-"`
}

AcceleratorConfig: Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.

func (AcceleratorConfig) MarshalJSON 

func (s AcceleratorConfig) 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 BootImage added in v0.71.0 

type BootImage struct {
}

BootImage: Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.

type CancelOperationRequest 

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type ContainerImage 

type ContainerImage struct {
	// Repository: Required. The path to the container image repository. For
	// example: `gcr.io/{project_id}/{image_name}`
	Repository string `json:"repository,omitempty"`
	// Tag: The tag of the container image. If not specified, this defaults to the
	// latest tag.
	Tag string `json:"tag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Repository") 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. "Repository") 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:"-"`
}

ContainerImage: Definition of a container image for starting a notebook instance with the environment installed in a container.

func (ContainerImage) MarshalJSON 

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

type DataprocParameters added in v0.55.0 

type DataprocParameters struct {
	// Cluster: URI for cluster used to run Dataproc execution. Format:
	// `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
	Cluster string `json:"cluster,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cluster") 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. "Cluster") 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:"-"`
}

DataprocParameters: Parameters used in Dataproc JobType executions.

func (DataprocParameters) MarshalJSON added in v0.55.0 

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

type DiagnoseInstanceRequest added in v0.100.0 

type DiagnoseInstanceRequest struct {
	// DiagnosticConfig: Required. Defines flags that are used to run the
	// diagnostic tool
	DiagnosticConfig *DiagnosticConfig `json:"diagnosticConfig,omitempty"`
	// TimeoutMinutes: Optional. Maximum amount of time in minutes before the
	// operation times out.
	TimeoutMinutes int64 `json:"timeoutMinutes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiagnosticConfig") 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. "DiagnosticConfig") 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:"-"`
}

DiagnoseInstanceRequest: Request for creating a notebook instance diagnostic file.

func (DiagnoseInstanceRequest) MarshalJSON added in v0.100.0 

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

type DiagnoseRuntimeRequest added in v0.100.0 

type DiagnoseRuntimeRequest struct {
	// DiagnosticConfig: Required. Defines flags that are used to run the
	// diagnostic tool
	DiagnosticConfig *DiagnosticConfig `json:"diagnosticConfig,omitempty"`
	// TimeoutMinutes: Optional. Maximum amount of time in minutes before the
	// operation times out.
	TimeoutMinutes int64 `json:"timeoutMinutes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiagnosticConfig") 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. "DiagnosticConfig") 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:"-"`
}

DiagnoseRuntimeRequest: Request for creating a notebook instance diagnostic file.

func (DiagnoseRuntimeRequest) MarshalJSON added in v0.100.0 

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

type DiagnosticConfig added in v0.100.0 

type DiagnosticConfig struct {
	// CopyHomeFilesFlagEnabled: Optional. Enables flag to copy all `/home/jupyter`
	// folder contents
	CopyHomeFilesFlagEnabled bool `json:"copyHomeFilesFlagEnabled,omitempty"`
	// GcsBucket: Required. User Cloud Storage bucket location (REQUIRED). Must be
	// formatted with path prefix (`gs://$GCS_BUCKET`). Permissions: User Managed
	// Notebooks: - storage.buckets.writer: Must be given to the project's service
	// account attached to VM. Google Managed Notebooks: - storage.buckets.writer:
	// Must be given to the project's service account or user credentials attached
	// to VM depending on authentication mode. Cloud Storage bucket Log file will
	// be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
	GcsBucket string `json:"gcsBucket,omitempty"`
	// PacketCaptureFlagEnabled: Optional. Enables flag to capture packets from the
	// instance for 30 seconds
	PacketCaptureFlagEnabled bool `json:"packetCaptureFlagEnabled,omitempty"`
	// RelativePath: Optional. Defines the relative storage path in the Cloud
	// Storage bucket where the diagnostic logs will be written: Default path will
	// be the root directory of the Cloud Storage bucket
	// (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
	// will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
	RelativePath string `json:"relativePath,omitempty"`
	// RepairFlagEnabled: Optional. Enables flag to repair service for instance
	RepairFlagEnabled bool `json:"repairFlagEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CopyHomeFilesFlagEnabled")
	// 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. "CopyHomeFilesFlagEnabled") 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:"-"`
}

DiagnosticConfig: Defines flags that are used to run the diagnostic tool

func (DiagnosticConfig) MarshalJSON added in v0.100.0 

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

type Disk 

type Disk struct {
	// AutoDelete: Indicates whether the disk will be auto-deleted when the
	// instance is deleted (but not when the disk is detached from the instance).
	AutoDelete bool `json:"autoDelete,omitempty"`
	// Boot: Indicates that this is a boot disk. The virtual machine will use the
	// first partition of the disk for its root filesystem.
	Boot bool `json:"boot,omitempty"`
	// DeviceName: Indicates a unique device name of your choice that is reflected
	// into the `/dev/disk/by-id/google-*` tree of a Linux operating system running
	// within the instance. This name can be used to reference the device for
	// mounting, resizing, and so on, from within the instance. If not specified,
	// the server chooses a default device name to apply to this disk, in the form
	// persistent-disk-x, where x is a number assigned by Google Compute
	// Engine.This field is only applicable for persistent disks.
	DeviceName string `json:"deviceName,omitempty"`
	// DiskSizeGb: Indicates the size of the disk in base-2 GB.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
	// GuestOsFeatures: Indicates a list of features to enable on the guest
	// operating system. Applicable only for bootable images. Read Enabling guest
	// operating system features to see a list of available options.
	GuestOsFeatures []*GuestOsFeature `json:"guestOsFeatures,omitempty"`
	// Index: A zero-based index to this disk, where 0 is reserved for the boot
	// disk. If you have many disks attached to an instance, each disk would have a
	// unique index number.
	Index int64 `json:"index,omitempty,string"`
	// Interface: Indicates the disk interface to use for attaching this disk,
	// which is either SCSI or NVME. The default is SCSI. Persistent disks must
	// always use SCSI and the request will fail if you attempt to attach a
	// persistent disk in any other format than SCSI. Local SSDs can use either
	// NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local
	// SSD performance. Valid values: * `NVME` * `SCSI`
	Interface string `json:"interface,omitempty"`
	// Kind: Type of the resource. Always compute#attachedDisk for attached disks.
	Kind string `json:"kind,omitempty"`
	// Licenses: A list of publicly visible licenses. Reserved for Google's use. A
	// License represents billing and aggregate usage data for public and
	// marketplace images.
	Licenses []string `json:"licenses,omitempty"`
	// Mode: The mode in which to attach this disk, either `READ_WRITE` or
	// `READ_ONLY`. If not specified, the default is to attach the disk in
	// `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`
	Mode string `json:"mode,omitempty"`
	// Source: Indicates a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string `json:"source,omitempty"`
	// Type: Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
	// Valid values: * `PERSISTENT` * `SCRATCH`
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AutoDelete") 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. "AutoDelete") 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:"-"`
}

Disk: An instance-attached disk resource.

func (Disk) MarshalJSON 

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

type Empty 

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

Empty: 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 EncryptionConfig added in v0.44.0 

type EncryptionConfig struct {
	// KmsKey: The Cloud KMS resource identifier of the customer-managed encryption
	// key used to protect a resource, such as a disks. It has the following
	// format:
	// `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys
	// /{KEY_NAME}`
	KmsKey string `json:"kmsKey,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:"-"`
}

EncryptionConfig: Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

func (EncryptionConfig) MarshalJSON added in v0.44.0 

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

type Environment 

type Environment struct {
	// ContainerImage: Use a container image to start the notebook instance.
	ContainerImage *ContainerImage `json:"containerImage,omitempty"`
	// CreateTime: Output only. The time at which this environment was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: A brief description of this environment.
	Description string `json:"description,omitempty"`
	// DisplayName: Display name of this environment for the UI.
	DisplayName string `json:"displayName,omitempty"`
	// Name: Output only. Name of this environment. Format:
	// `projects/{project_id}/locations/{location}/environments/{environment_id}`
	Name string `json:"name,omitempty"`
	// PostStartupScript: Path to a Bash script that automatically runs after a
	// notebook instance fully boots up. The path must be a URL or Cloud Storage
	// path. Example: "gs://path-to-file/file-name"
	PostStartupScript string `json:"postStartupScript,omitempty"`
	// VmImage: Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage `json:"vmImage,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ContainerImage") 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. "ContainerImage") 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:"-"`
}

Environment: Definition of a software environment that is used to start a notebook instance.

func (Environment) MarshalJSON 

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

type Event added in v0.51.0 

type Event struct {
	// Details: Optional. Event details. This field is used to pass event
	// information.
	Details map[string]string `json:"details,omitempty"`
	// ReportTime: Event report time.
	ReportTime string `json:"reportTime,omitempty"`
	// Type: Event type.
	//
	// Possible values:
	//   "EVENT_TYPE_UNSPECIFIED" - Event is not specified.
	//   "IDLE" - The instance / runtime is idle
	//   "HEARTBEAT" - The instance / runtime is available. This event indicates
	// that instance / runtime underlying compute is operational.
	//   "HEALTH" - The instance / runtime health is available. This event
	// indicates that instance / runtime health information.
	//   "MAINTENANCE" - The instance / runtime is available. This event allows
	// instance / runtime to send Host maintenance information to Control Plane.
	// https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") 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. "Details") 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:"-"`
}

Event: The definition of an Event for a managed / semi-managed notebook instance.

func (Event) MarshalJSON added in v0.51.0 

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

type Execution added in v0.38.0 

type Execution struct {
	// CreateTime: Output only. Time the Execution was instantiated.
	CreateTime string `json:"createTime,omitempty"`
	// Description: A brief description of this execution.
	Description string `json:"description,omitempty"`
	// DisplayName: Output only. Name used for UI purposes. Name can only contain
	// alphanumeric characters and underscores '_'.
	DisplayName string `json:"displayName,omitempty"`
	// ExecutionTemplate: execute metadata including name, hardware spec, region,
	// labels, etc.
	ExecutionTemplate *ExecutionTemplate `json:"executionTemplate,omitempty"`
	// JobUri: Output only. The URI of the external job used to execute the
	// notebook.
	JobUri string `json:"jobUri,omitempty"`
	// Name: Output only. The resource name of the execute. Format:
	// `projects/{project_id}/locations/{location}/executions/{execution_id}`
	Name string `json:"name,omitempty"`
	// OutputNotebookFile: Output notebook file generated by this execution
	OutputNotebookFile string `json:"outputNotebookFile,omitempty"`
	// State: Output only. State of the underlying AI Platform job.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The job state is unspecified.
	//   "QUEUED" - The job has been just created and processing has not yet begun.
	//   "PREPARING" - The service is preparing to execution the job.
	//   "RUNNING" - The job is in progress.
	//   "SUCCEEDED" - The job completed successfully.
	//   "FAILED" - The job failed. `error_message` should contain the details of
	// the failure.
	//   "CANCELLING" - The job is being cancelled. `error_message` should describe
	// the reason for the cancellation.
	//   "CANCELLED" - The job has been cancelled. `error_message` should describe
	// the reason for the cancellation.
	//   "EXPIRED" - The job has become expired (relevant to Vertex AI jobs)
	// https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
	//   "INITIALIZING" - The Execution is being created.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. Time the Execution was last 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. "CreateTime") 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. "CreateTime") 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:"-"`
}

Execution: The definition of a single executed notebook.

func (Execution) MarshalJSON added in v0.38.0 

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

type ExecutionTemplate added in v0.38.0 

type ExecutionTemplate struct {
	// AcceleratorConfig: Configuration (count and accelerator type) for hardware
	// running notebook execution.
	AcceleratorConfig *SchedulerAcceleratorConfig `json:"acceleratorConfig,omitempty"`
	// ContainerImageUri: Container Image URI to a DLVM Example:
	// 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found
	// at:
	// https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
	ContainerImageUri string `json:"containerImageUri,omitempty"`
	// DataprocParameters: Parameters used in Dataproc JobType executions.
	DataprocParameters *DataprocParameters `json:"dataprocParameters,omitempty"`
	// InputNotebookFile: Path to the notebook file to execute. Must be in a Google
	// Cloud Storage bucket. Format:
	// `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex:
	// `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
	InputNotebookFile string `json:"inputNotebookFile,omitempty"`
	// JobType: The type of Job to be used on this execution.
	//
	// Possible values:
	//   "JOB_TYPE_UNSPECIFIED" - No type specified.
	//   "VERTEX_AI" - Custom Job in `aiplatform.googleapis.com`. Default value for
	// an execution.
	//   "DATAPROC" - Run execution on a cluster with Dataproc as a job.
	// https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs
	JobType string `json:"jobType,omitempty"`
	// KernelSpec: Name of the kernel spec to use. This must be specified if the
	// kernel spec name on the execution target does not match the name in the
	// input notebook file.
	KernelSpec string `json:"kernelSpec,omitempty"`
	// Labels: Labels for execution. If execution is scheduled, a field included
	// will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an
	// included field will be 'nbs-immediate'. Use fields to efficiently index
	// between various types of executions.
	Labels map[string]string `json:"labels,omitempty"`
	// MasterType: Specifies the type of virtual machine to use for your training
	// job's master worker. You must specify this field when `scaleTier` is set to
	// `CUSTOM`. You can use certain Compute Engine machine types directly in this
	// field. The following types are supported: - `n1-standard-4` -
	// `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` -
	// `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` -
	// `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` -
	// `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96`
	// Alternatively, you can use the following legacy machine types: - `standard`
	// - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l`
	// - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` -
	// `standard_p100` - `complex_model_m_p100` - `standard_v100` -
	// `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100`
	// Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
	// field. Learn more about the special configuration options for training with
	// TPU
	// (https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
	MasterType string `json:"masterType,omitempty"`
	// OutputNotebookFolder: Path to the notebook folder to write to. Must be in a
	// Google Cloud Storage bucket path. Format: `gs://{bucket_name}/{folder}` Ex:
	// `gs://notebook_user/scheduled_notebooks`
	OutputNotebookFolder string `json:"outputNotebookFolder,omitempty"`
	// Parameters: Parameters used within the 'input_notebook_file' notebook.
	Parameters string `json:"parameters,omitempty"`
	// ParamsYamlFile: Parameters to be overridden in the notebook during
	// execution. Ref
	// https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to
	// specifying parameters in the input notebook and pass them here in an YAML
	// file. Ex:
	// `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
	ParamsYamlFile string `json:"paramsYamlFile,omitempty"`
	// ScaleTier: Required. Scale tier of the hardware used for notebook execution.
	// DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
	//
	// Possible values:
	//   "SCALE_TIER_UNSPECIFIED" - Unspecified Scale Tier.
	//   "BASIC" - A single worker instance. This tier is suitable for learning how
	// to use Cloud ML, and for experimenting with new models using small datasets.
	//   "STANDARD_1" - Many workers and a few parameter servers.
	//   "PREMIUM_1" - A large number of workers with many parameter servers.
	//   "BASIC_GPU" - A single worker instance with a K80 GPU.
	//   "BASIC_TPU" - A single worker instance with a Cloud TPU.
	//   "CUSTOM" - The CUSTOM tier is not a set tier, but rather enables you to
	// use your own cluster specification. When you use this tier, set values to
	// configure your processing cluster according to these guidelines: * You
	// _must_ set `ExecutionTemplate.masterType` to specify the type of machine to
	// use for your master node. This is the only required setting.
	ScaleTier string `json:"scaleTier,omitempty"`
	// ServiceAccount: The email address of a service account to use when running
	// the execution. You must have the `iam.serviceAccounts.actAs` permission for
	// the specified service account.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// Tensorboard: The name of a Vertex AI [Tensorboard] resource to which this
	// execution will upload Tensorboard logs. Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string `json:"tensorboard,omitempty"`
	// VertexAiParameters: Parameters used in Vertex AI JobType executions.
	VertexAiParameters *VertexAIParameters `json:"vertexAiParameters,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AcceleratorConfig") 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. "AcceleratorConfig") 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:"-"`
}

ExecutionTemplate: The description a notebook execution workload.

func (ExecutionTemplate) MarshalJSON added in v0.38.0 

func (s ExecutionTemplate) 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 GetInstanceHealthResponse added in v0.37.0 

type GetInstanceHealthResponse struct {
	// HealthInfo: Output only. Additional information about instance health.
	// Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status":
	// "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated":
	// "2020-10-18 09:40:03.573409" }
	HealthInfo map[string]string `json:"healthInfo,omitempty"`
	// HealthState: Output only. Runtime health_state.
	//
	// Possible values:
	//   "HEALTH_STATE_UNSPECIFIED" - The instance substate is unknown.
	//   "HEALTHY" - The instance is known to be in an healthy state (for example,
	// critical daemons are running) Applies to ACTIVE state.
	//   "UNHEALTHY" - The instance is known to be in an unhealthy state (for
	// example, critical daemons are not running) Applies to ACTIVE state.
	//   "AGENT_NOT_INSTALLED" - The instance has not installed health monitoring
	// agent. Applies to ACTIVE state.
	//   "AGENT_NOT_RUNNING" - The instance health monitoring agent is not running.
	// Applies to ACTIVE state.
	HealthState string `json:"healthState,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "HealthInfo") 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. "HealthInfo") 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:"-"`
}

GetInstanceHealthResponse: Response for checking if a notebook instance is healthy.

func (GetInstanceHealthResponse) MarshalJSON added in v0.37.0 

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

type GuestOsFeature 

type GuestOsFeature struct {
	// Type: The ID of a supported feature. Read Enabling guest operating system
	// features to see a list of available options. Valid values: *
	// `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` *
	// `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") 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. "Type") 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:"-"`
}

GuestOsFeature: Guest OS features for boot disk.

func (GuestOsFeature) MarshalJSON 

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

type Instance 

type Instance struct {
	// AcceleratorConfig: The hardware accelerator used on this instance. If you
	// use accelerators, make sure that your configuration has enough vCPUs and
	// memory to support the `machine_type` you have selected
	// (https://cloud.google.com/compute/docs/gpus/#gpus-list).
	AcceleratorConfig *AcceleratorConfig `json:"acceleratorConfig,omitempty"`
	// BootDiskSizeGb: Input only. The size of the boot disk in GB attached to this
	// instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value
	// is 100 GB. If not specified, this defaults to 100.
	BootDiskSizeGb int64 `json:"bootDiskSizeGb,omitempty,string"`
	// BootDiskType: Input only. The type of the boot disk attached to this
	// instance, defaults to standard persistent disk (`PD_STANDARD`).
	//
	// Possible values:
	//   "DISK_TYPE_UNSPECIFIED" - Disk type not set.
	//   "PD_STANDARD" - Standard persistent disk type.
	//   "PD_SSD" - SSD persistent disk type.
	//   "PD_BALANCED" - Balanced persistent disk type.
	//   "PD_EXTREME" - Extreme persistent disk type.
	BootDiskType string `json:"bootDiskType,omitempty"`
	// CanIpForward: Optional. Flag to enable ip forwarding or not, default
	// false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
	CanIpForward bool `json:"canIpForward,omitempty"`
	// ContainerImage: Use a container image to start the notebook instance.
	ContainerImage *ContainerImage `json:"containerImage,omitempty"`
	// CreateTime: Output only. Instance creation time.
	CreateTime string `json:"createTime,omitempty"`
	// Creator: Output only. Email address of entity that sent original
	// CreateInstance request.
	Creator string `json:"creator,omitempty"`
	// CustomGpuDriverPath: Specify a custom Cloud Storage path where the GPU
	// driver is stored. If not specified, we'll automatically choose from official
	// GPU drivers.
	CustomGpuDriverPath string `json:"customGpuDriverPath,omitempty"`
	// DataDiskSizeGb: Input only. The size of the data disk in GB attached to this
	// instance, up to a maximum of 64000 GB (64 TB). You can choose the size of
	// the data disk based on how big your notebooks and data are. If not
	// specified, this defaults to 100.
	DataDiskSizeGb int64 `json:"dataDiskSizeGb,omitempty,string"`
	// DataDiskType: Input only. The type of the data disk attached to this
	// instance, defaults to standard persistent disk (`PD_STANDARD`).
	//
	// Possible values:
	//   "DISK_TYPE_UNSPECIFIED" - Disk type not set.
	//   "PD_STANDARD" - Standard persistent disk type.
	//   "PD_SSD" - SSD persistent disk type.
	//   "PD_BALANCED" - Balanced persistent disk type.
	//   "PD_EXTREME" - Extreme persistent disk type.
	DataDiskType string `json:"dataDiskType,omitempty"`
	// DiskEncryption: Input only. Disk encryption method used on the boot and data
	// disks, defaults to GMEK.
	//
	// Possible values:
	//   "DISK_ENCRYPTION_UNSPECIFIED" - Disk encryption is not specified.
	//   "GMEK" - Use Google managed encryption keys to encrypt the boot disk.
	//   "CMEK" - Use customer managed encryption keys to encrypt the boot disk.
	DiskEncryption string `json:"diskEncryption,omitempty"`
	// Disks: Output only. Attached disks to notebook instance.
	Disks []*Disk `json:"disks,omitempty"`
	// InstallGpuDriver: Whether the end user authorizes Google Cloud to install
	// GPU driver on this instance. If this field is empty or set to false, the GPU
	// driver won't be installed. Only applicable to instances with GPUs.
	InstallGpuDriver bool `json:"installGpuDriver,omitempty"`
	// InstanceMigrationEligibility: Output only. Checks how feasible a migration
	// from UmN to WbI is.
	InstanceMigrationEligibility *InstanceMigrationEligibility `json:"instanceMigrationEligibility,omitempty"`
	// InstanceOwners: Input only. The owner of this instance after creation.
	// Format: `alias@example.com` Currently supports one owner only. If not
	// specified, all of the service account users of your VM instance's service
	// account can use the instance.
	InstanceOwners []string `json:"instanceOwners,omitempty"`
	// KmsKey: Input only. The KMS key used to encrypt the disks, only applicable
	// if disk_encryption is CMEK. Format:
	// `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys
	// /{key_id}` Learn more about using your own encryption keys
	// (/kms/docs/quickstart).
	KmsKey string `json:"kmsKey,omitempty"`
	// Labels: Labels to apply to this instance. These can be later modified by the
	// setLabels method.
	Labels map[string]string `json:"labels,omitempty"`
	// MachineType: Required. The Compute Engine machine type
	// (https://cloud.google.com/compute/docs/machine-resource) of this instance.
	MachineType string `json:"machineType,omitempty"`
	// Metadata: Custom metadata to apply to this instance. For example, to specify
	// a Cloud Storage bucket for automatic backup, you can use the
	// `gcs-data-bucket` metadata tag. Format:
	// "--metadata=gcs-data-bucket=BUCKET".
	Metadata map[string]string `json:"metadata,omitempty"`
	// Migrated: Output only. Bool indicating whether this notebook has been
	// migrated to a Workbench Instance
	Migrated bool `json:"migrated,omitempty"`
	// Name: Output only. The name of this notebook instance. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `json:"name,omitempty"`
	// Network: The name of the VPC that this instance is in. Format:
	// `projects/{project_id}/global/networks/{network_id}`
	Network string `json:"network,omitempty"`
	// NicType: Optional. The type of vNIC to be used on this interface. This may
	// be gVNIC or VirtioNet.
	//
	// Possible values:
	//   "UNSPECIFIED_NIC_TYPE" - No type specified.
	//   "VIRTIO_NET" - VIRTIO
	//   "GVNIC" - GVNIC
	NicType string `json:"nicType,omitempty"`
	// NoProxyAccess: If true, the notebook instance will not register with the
	// proxy.
	NoProxyAccess bool `json:"noProxyAccess,omitempty"`
	// NoPublicIp: If true, no external IP will be assigned to this instance.
	NoPublicIp bool `json:"noPublicIp,omitempty"`
	// NoRemoveDataDisk: Input only. If true, the data disk will not be auto
	// deleted when deleting the instance.
	NoRemoveDataDisk bool `json:"noRemoveDataDisk,omitempty"`
	// PostStartupScript: Path to a Bash script that automatically runs after a
	// notebook instance fully boots up. The path must be a URL or Cloud Storage
	// path (`gs://path-to-file/file-name`).
	PostStartupScript string `json:"postStartupScript,omitempty"`
	// ProxyUri: Output only. The proxy endpoint that is used to access the Jupyter
	// notebook.
	ProxyUri string `json:"proxyUri,omitempty"`
	// ReservationAffinity: Optional. The optional reservation affinity. Setting
	// this field will apply the specified Zonal Compute Reservation
	// (https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
	// to this notebook instance.
	ReservationAffinity *ReservationAffinity `json:"reservationAffinity,omitempty"`
	// ServiceAccount: The service account on this instance, giving access to other
	// Google Cloud services. You can use any service account within the same
	// project, but you must have the service account user permission to use the
	// instance. If not specified, the Compute Engine default service account
	// (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
	// is used.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// ServiceAccountScopes: Optional. The URIs of service account scopes to be
	// included in Compute Engine instances. If not specified, the following scopes
	// (https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
	// are defined: - https://www.googleapis.com/auth/cloud-platform -
	// https://www.googleapis.com/auth/userinfo.email If not using default scopes,
	// you need at least: https://www.googleapis.com/auth/compute
	ServiceAccountScopes []string `json:"serviceAccountScopes,omitempty"`
	// ShieldedInstanceConfig: Optional. Shielded VM configuration. Images using
	// supported Shielded VM features
	// (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
	ShieldedInstanceConfig *ShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"`
	// State: Output only. The state of this instance.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - State is not specified.
	//   "STARTING" - The control logic is starting the instance.
	//   "PROVISIONING" - The control logic is installing required frameworks and
	// registering the instance with notebook proxy
	//   "ACTIVE" - The instance is running.
	//   "STOPPING" - The control logic is stopping the instance.
	//   "STOPPED" - The instance is stopped.
	//   "DELETED" - The instance is deleted.
	//   "UPGRADING" - The instance is upgrading.
	//   "INITIALIZING" - The instance is being created.
	//   "REGISTERING" - The instance is getting registered.
	//   "SUSPENDING" - The instance is suspending.
	//   "SUSPENDED" - The instance is suspended.
	State string `json:"state,omitempty"`
	// Subnet: The name of the subnet that this instance is in. Format:
	// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnet string `json:"subnet,omitempty"`
	// Tags: Optional. The Compute Engine network tags to add to runtime (see Add
	// network tags (https://cloud.google.com/vpc/docs/add-remove-network-tags)).
	Tags []string `json:"tags,omitempty"`
	// UpdateTime: Output only. Instance update time.
	UpdateTime string `json:"updateTime,omitempty"`
	// UpgradeHistory: The upgrade history of this instance.
	UpgradeHistory []*UpgradeHistoryEntry `json:"upgradeHistory,omitempty"`
	// VmImage: Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage `json:"vmImage,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AcceleratorConfig") 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. "AcceleratorConfig") 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:"-"`
}

Instance: The definition of a notebook instance.

func (Instance) MarshalJSON 

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

type InstanceConfig added in v0.49.0 

type InstanceConfig struct {
	// EnableHealthMonitoring: Verifies core internal services are running.
	EnableHealthMonitoring bool `json:"enableHealthMonitoring,omitempty"`
	// NotebookUpgradeSchedule: Cron expression in UTC timezone, used to schedule
	// instance auto upgrade. Please follow the cron format
	// (https://en.wikipedia.org/wiki/Cron).
	NotebookUpgradeSchedule string `json:"notebookUpgradeSchedule,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableHealthMonitoring") 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. "EnableHealthMonitoring") 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:"-"`
}

InstanceConfig: Notebook instance configurations that can be updated.

func (InstanceConfig) MarshalJSON added in v0.49.0 

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

type InstanceMigrationEligibility added in v0.142.0 

type InstanceMigrationEligibility struct {
	// Errors: Output only. Certain configurations make the UmN ineligible for an
	// automatic migration. A manual migration is required.
	//
	// Possible values:
	//   "ERROR_UNSPECIFIED" - Default type.
	//   "DATAPROC_HUB" - The UmN uses Dataproc Hub and cannot be migrated.
	Errors []string `json:"errors,omitempty"`
	// Warnings: Output only. Certain configurations will be defaulted during the
	// migration.
	//
	// Possible values:
	//   "WARNING_UNSPECIFIED" - Default type.
	//   "UNSUPPORTED_MACHINE_TYPE" - The UmN uses an machine type that's
	// unsupported in WbI. It will be migrated with the default machine type
	// e2-standard-4. Users can change the machine type after the migration.
	//   "UNSUPPORTED_ACCELERATOR_TYPE" - The UmN uses an accelerator type that's
	// unsupported in WbI. It will be migrated without an accelerator. User can
	// attach an accelerator after the migration.
	//   "UNSUPPORTED_OS" - The UmN uses an operating system that's unsupported in
	// WbI (e.g. Debian 10, Ubuntu). It will be replaced with Debian 11 in WbI.
	//   "NO_REMOVE_DATA_DISK" - This UmN is configured with no_remove_data_disk,
	// which is no longer available in WbI.
	//   "GCS_BACKUP" - This UmN is configured with the Cloud Storage backup
	// feature, which is no longer available in WbI.
	//   "POST_STARTUP_SCRIPT" - This UmN is configured with a post startup script.
	// Please optionally provide the `post_startup_script_option` for the
	// migration.
	Warnings []string `json:"warnings,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Errors") 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. "Errors") 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:"-"`
}

InstanceMigrationEligibility: InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.

func (InstanceMigrationEligibility) MarshalJSON added in v0.142.0 

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

type IsInstanceUpgradeableResponse 

type IsInstanceUpgradeableResponse struct {
	// UpgradeImage: The new image self link this instance will be upgraded to if
	// calling the upgrade endpoint. This field will only be populated if field
	// upgradeable is true.
	UpgradeImage string `json:"upgradeImage,omitempty"`
	// UpgradeInfo: Additional information about upgrade.
	UpgradeInfo string `json:"upgradeInfo,omitempty"`
	// UpgradeVersion: The version this instance will be upgraded to if calling the
	// upgrade endpoint. This field will only be populated if field upgradeable is
	// true.
	UpgradeVersion string `json:"upgradeVersion,omitempty"`
	// Upgradeable: If an instance is upgradeable.
	Upgradeable bool `json:"upgradeable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "UpgradeImage") 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. "UpgradeImage") 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:"-"`
}

IsInstanceUpgradeableResponse: Response for checking if a notebook instance is upgradeable.

func (IsInstanceUpgradeableResponse) MarshalJSON 

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

type ListEnvironmentsResponse 

type ListEnvironmentsResponse struct {
	// Environments: A list of returned environments.
	Environments []*Environment `json:"environments,omitempty"`
	// NextPageToken: A page token that can be used to continue listing from the
	// last result in the next list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Environments") 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. "Environments") 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:"-"`
}

ListEnvironmentsResponse: Response for listing environments.

func (ListEnvironmentsResponse) MarshalJSON 

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

type ListExecutionsResponse added in v0.38.0 

type ListExecutionsResponse struct {
	// Executions: A list of returned instances.
	Executions []*Execution `json:"executions,omitempty"`
	// NextPageToken: Page token that can be used to continue listing from the last
	// result in the next list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Executions IDs that could not be reached. For example:
	// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
	// 'projects/{project_id}/location/{location}/executions/classifier_train1']
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Executions") 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. "Executions") 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:"-"`
}

ListExecutionsResponse: Response for listing scheduled notebook executions

func (ListExecutionsResponse) MarshalJSON added in v0.38.0 

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

type ListInstancesResponse 

type ListInstancesResponse struct {
	// Instances: A list of returned instances.
	Instances []*Instance `json:"instances,omitempty"`
	// NextPageToken: Page token that can be used to continue listing from the last
	// result in the next list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Locations that could not be reached. For example,
	// `['us-west1-a', 'us-central1-b']`. A ListInstancesResponse will only contain
	// either instances or unreachables,
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Instances") 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. "Instances") 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:"-"`
}

ListInstancesResponse: Response for listing notebook instances.

func (ListInstancesResponse) MarshalJSON 

func (s ListInstancesResponse) 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 ListRuntimesResponse added in v0.44.0 

type ListRuntimesResponse struct {
	// NextPageToken: Page token that can be used to continue listing from the last
	// result in the next list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Runtimes: A list of returned Runtimes.
	Runtimes []*Runtime `json:"runtimes,omitempty"`
	// Unreachable: Locations that could not be reached. For example, `['us-west1',
	// 'us-central1']`. A ListRuntimesResponse will only contain either runtimes or
	// unreachables,
	Unreachable []string `json:"unreachable,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:"-"`
}

ListRuntimesResponse: Response for listing Managed Notebook Runtimes.

func (ListRuntimesResponse) MarshalJSON added in v0.44.0 

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

type ListSchedulesResponse added in v0.38.0 

type ListSchedulesResponse struct {
	// NextPageToken: Page token that can be used to continue listing from the last
	// result in the next list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Schedules: A list of returned instances.
	Schedules []*Schedule `json:"schedules,omitempty"`
	// Unreachable: Schedules that could not be reached. For example:
	// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
	// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
	Unreachable []string `json:"unreachable,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:"-"`
}

ListSchedulesResponse: Response for listing scheduled notebook job.

func (ListSchedulesResponse) MarshalJSON added in v0.38.0 

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

type LocalDisk added in v0.44.0 

type LocalDisk struct {
	// AutoDelete: Optional. Output only. Specifies whether the disk will be
	// auto-deleted when the instance is deleted (but not when the disk is detached
	// from the instance).
	AutoDelete bool `json:"autoDelete,omitempty"`
	// Boot: Optional. Output only. Indicates that this is a boot disk. The virtual
	// machine will use the first partition of the disk for its root filesystem.
	Boot bool `json:"boot,omitempty"`
	// DeviceName: Optional. Output only. Specifies a unique device name of your
	// choice that is reflected into the `/dev/disk/by-id/google-*` tree of a Linux
	// operating system running within the instance. This name can be used to
	// reference the device for mounting, resizing, and so on, from within the
	// instance. If not specified, the server chooses a default device name to
	// apply to this disk, in the form persistent-disk-x, where x is a number
	// assigned by Google Compute Engine. This field is only applicable for
	// persistent disks.
	DeviceName string `json:"deviceName,omitempty"`
	// GuestOsFeatures: Output only. Indicates a list of features to enable on the
	// guest operating system. Applicable only for bootable images. Read Enabling
	// guest operating system features to see a list of available options.
	GuestOsFeatures []*RuntimeGuestOsFeature `json:"guestOsFeatures,omitempty"`
	// Index: Output only. A zero-based index to this disk, where 0 is reserved for
	// the boot disk. If you have many disks attached to an instance, each disk
	// would have a unique index number.
	Index int64 `json:"index,omitempty"`
	// InitializeParams: Input only. Specifies the parameters for a new disk that
	// will be created alongside the new instance. Use initialization parameters to
	// create boot disks or local SSDs attached to the new instance. This property
	// is mutually exclusive with the source property; you can only define one or
	// the other, but not both.
	InitializeParams *LocalDiskInitializeParams `json:"initializeParams,omitempty"`
	// Interface: Specifies the disk interface to use for attaching this disk,
	// which is either SCSI or NVME. The default is SCSI. Persistent disks must
	// always use SCSI and the request will fail if you attempt to attach a
	// persistent disk in any other format than SCSI. Local SSDs can use either
	// NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local
	// SSD performance. Valid values: * `NVME` * `SCSI`
	Interface string `json:"interface,omitempty"`
	// Kind: Output only. Type of the resource. Always compute#attachedDisk for
	// attached disks.
	Kind string `json:"kind,omitempty"`
	// Licenses: Output only. Any valid publicly visible licenses.
	Licenses []string `json:"licenses,omitempty"`
	// Mode: The mode in which to attach this disk, either `READ_WRITE` or
	// `READ_ONLY`. If not specified, the default is to attach the disk in
	// `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`
	Mode string `json:"mode,omitempty"`
	// Source: Specifies a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string `json:"source,omitempty"`
	// Type: Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If
	// not specified, the default is `PERSISTENT`. Valid values: * `PERSISTENT` *
	// `SCRATCH`
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AutoDelete") 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. "AutoDelete") 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:"-"`
}

LocalDisk: A Local attached disk resource.

func (LocalDisk) MarshalJSON added in v0.44.0 

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

type LocalDiskInitializeParams added in v0.44.0 

type LocalDiskInitializeParams struct {
	// Description: Optional. Provide this property when creating the disk.
	Description string `json:"description,omitempty"`
	// DiskName: Optional. Specifies the disk name. If not specified, the default
	// is to use the name of the instance. If the disk with the instance name
	// exists already in the given zone/region, a new name will be automatically
	// generated.
	DiskName string `json:"diskName,omitempty"`
	// DiskSizeGb: Optional. Specifies the size of the disk in base-2 GB. If not
	// specified, the disk will be the same size as the image (usually 10GB). If
	// specified, the size must be equal to or larger than 10GB. Default 100 GB.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
	// DiskType: Input only. The type of the boot disk attached to this instance,
	// defaults to standard persistent disk (`PD_STANDARD`).
	//
	// Possible values:
	//   "DISK_TYPE_UNSPECIFIED" - Disk type not set.
	//   "PD_STANDARD" - Standard persistent disk type.
	//   "PD_SSD" - SSD persistent disk type.
	//   "PD_BALANCED" - Balanced persistent disk type.
	//   "PD_EXTREME" - Extreme persistent disk type.
	DiskType string `json:"diskType,omitempty"`
	// Labels: Optional. Labels to apply to this disk. These can be later modified
	// by the disks.setLabels method. This field is only applicable for persistent
	// disks.
	Labels map[string]string `json:"labels,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:"-"`
}

LocalDiskInitializeParams: Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

func (LocalDiskInitializeParams) MarshalJSON added in v0.44.0 

func (s LocalDiskInitializeParams) 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 MigrateInstanceRequest added in v0.148.0 

type MigrateInstanceRequest struct {
	// PostStartupScriptOption: Optional. Specifies the behavior of post startup
	// script during migration.
	//
	// Possible values:
	//   "POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED" - Post startup script option is
	// not specified. Default is POST_STARTUP_SCRIPT_OPTION_SKIP.
	//   "POST_STARTUP_SCRIPT_OPTION_SKIP" - Not migrate the post startup script to
	// the new Workbench Instance.
	//   "POST_STARTUP_SCRIPT_OPTION_RERUN" - Redownload and rerun the same post
	// startup script as the User-Managed Notebook.
	PostStartupScriptOption string `json:"postStartupScriptOption,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PostStartupScriptOption") 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. "PostStartupScriptOption") 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:"-"`
}

MigrateInstanceRequest: Request for migrating a User-Managed Notebook to Workbench Instances.

func (MigrateInstanceRequest) MarshalJSON added in v0.148.0 

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

type MigrateRuntimeRequest added in v0.148.0 

type MigrateRuntimeRequest struct {
	// Network: Optional. Name of the VPC that the new Instance is in. This is
	// required if the Runtime uses google-managed network. If the Runtime uses
	// customer-owned network, it will reuse the same VPC, and this field must be
	// empty. Format: `projects/{project_id}/global/networks/{network_id}`
	Network string `json:"network,omitempty"`
	// PostStartupScriptOption: Optional. Specifies the behavior of post startup
	// script during migration.
	//
	// Possible values:
	//   "POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED" - Post startup script option is
	// not specified. Default is POST_STARTUP_SCRIPT_OPTION_SKIP.
	//   "POST_STARTUP_SCRIPT_OPTION_SKIP" - Not migrate the post startup script to
	// the new Workbench Instance.
	//   "POST_STARTUP_SCRIPT_OPTION_RERUN" - Redownload and rerun the same post
	// startup script as the Google-Managed Notebook.
	PostStartupScriptOption string `json:"postStartupScriptOption,omitempty"`
	// RequestId: Optional. Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ServiceAccount: Optional. The service account to be included in the Compute
	// Engine instance of the new Workbench Instance when the Runtime uses "single
	// user only" mode for permission. If not specified, the Compute Engine default
	// service account
	// (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
	// is used. When the Runtime uses service account mode for permission, it will
	// reuse the same service account, and this field must be empty.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// Subnet: Optional. Name of the subnet that the new Instance is in. This is
	// required if the Runtime uses google-managed network. If the Runtime uses
	// customer-owned network, it will reuse the same subnet, and this field must
	// be empty. Format:
	// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnet string `json:"subnet,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Network") 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. "Network") 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:"-"`
}

MigrateRuntimeRequest: Request for migrating a Runtime to a Workbench Instance.

func (MigrateRuntimeRequest) MarshalJSON added in v0.148.0 

func (s MigrateRuntimeRequest) 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: API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// Endpoint: API endpoint name of this operation.
	Endpoint string `json:"endpoint,omitempty"`
	// RequestedCancellation: Identifies whether the user has requested
	// cancellation of the operation. Operations that have successfully been
	// cancelled have google.longrunning.Operation.error value with a
	// google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Server-defined resource path for the target of the operation.
	Target string `json:"target,omitempty"`
	// Verb: 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: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON 

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

type Policy 

type Policy struct {
	// 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. "Bindings") 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. "Bindings") 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 ProjectsLocationsEnvironmentsCreateCall 

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

func (*ProjectsLocationsEnvironmentsCreateCall) Context 

func (c *ProjectsLocationsEnvironmentsCreateCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsCreateCall

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

func (*ProjectsLocationsEnvironmentsCreateCall) Do 

func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.environments.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 (*ProjectsLocationsEnvironmentsCreateCall) EnvironmentId 

func (c *ProjectsLocationsEnvironmentsCreateCall) EnvironmentId(environmentId string) *ProjectsLocationsEnvironmentsCreateCall

EnvironmentId sets the optional parameter "environmentId": Required. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

func (*ProjectsLocationsEnvironmentsCreateCall) Fields 

func (c *ProjectsLocationsEnvironmentsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsCreateCall

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

func (*ProjectsLocationsEnvironmentsCreateCall) Header 

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

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

type ProjectsLocationsEnvironmentsDeleteCall 

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

func (*ProjectsLocationsEnvironmentsDeleteCall) Context 

func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall

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

func (*ProjectsLocationsEnvironmentsDeleteCall) Do 

func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.environments.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 (*ProjectsLocationsEnvironmentsDeleteCall) Fields 

func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall

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

func (*ProjectsLocationsEnvironmentsDeleteCall) Header 

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

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

type ProjectsLocationsEnvironmentsGetCall 

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

func (*ProjectsLocationsEnvironmentsGetCall) Context 

func (c *ProjectsLocationsEnvironmentsGetCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsGetCall

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

func (*ProjectsLocationsEnvironmentsGetCall) Do 

func (c *ProjectsLocationsEnvironmentsGetCall) Do(opts ...googleapi.CallOption) (*Environment, error)

Do executes the "notebooks.projects.locations.environments.get" call. Any non-2xx status code is an error. Response headers are in either *Environment.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 (*ProjectsLocationsEnvironmentsGetCall) Fields 

func (c *ProjectsLocationsEnvironmentsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsGetCall

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

func (*ProjectsLocationsEnvironmentsGetCall) Header 

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

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

func (*ProjectsLocationsEnvironmentsGetCall) IfNoneMatch 

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

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 ProjectsLocationsEnvironmentsListCall 

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

func (*ProjectsLocationsEnvironmentsListCall) Context 

func (c *ProjectsLocationsEnvironmentsListCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsListCall

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

func (*ProjectsLocationsEnvironmentsListCall) Do 

func (c *ProjectsLocationsEnvironmentsListCall) Do(opts ...googleapi.CallOption) (*ListEnvironmentsResponse, error)

Do executes the "notebooks.projects.locations.environments.list" call. Any non-2xx status code is an error. Response headers are in either *ListEnvironmentsResponse.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 (*ProjectsLocationsEnvironmentsListCall) Fields 

func (c *ProjectsLocationsEnvironmentsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsListCall

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

func (*ProjectsLocationsEnvironmentsListCall) Header 

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

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

func (*ProjectsLocationsEnvironmentsListCall) IfNoneMatch 

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

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 (*ProjectsLocationsEnvironmentsListCall) PageSize 

func (c *ProjectsLocationsEnvironmentsListCall) PageSize(pageSize int64) *ProjectsLocationsEnvironmentsListCall

PageSize sets the optional parameter "pageSize": Maximum return size of the list call.

func (*ProjectsLocationsEnvironmentsListCall) PageToken 

func (c *ProjectsLocationsEnvironmentsListCall) PageToken(pageToken string) *ProjectsLocationsEnvironmentsListCall

PageToken sets the optional parameter "pageToken": A previous returned page token that can be used to continue listing from the last result.

func (*ProjectsLocationsEnvironmentsListCall) Pages 

func (c *ProjectsLocationsEnvironmentsListCall) Pages(ctx context.Context, f func(*ListEnvironmentsResponse) error) error

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 ProjectsLocationsEnvironmentsService 

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

func NewProjectsLocationsEnvironmentsService 

func NewProjectsLocationsEnvironmentsService(s *Service) *ProjectsLocationsEnvironmentsService

func (*ProjectsLocationsEnvironmentsService) Create 

func (r *ProjectsLocationsEnvironmentsService) Create(parent string, environment *Environment) *ProjectsLocationsEnvironmentsCreateCall

Create: Creates a new Environment.

- parent: Format: `projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsEnvironmentsService) Delete 

func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall

Delete: Deletes a single Environment.

  • name: Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`.

func (*ProjectsLocationsEnvironmentsService) Get 

func (r *ProjectsLocationsEnvironmentsService) Get(name string) *ProjectsLocationsEnvironmentsGetCall

Get: Gets details of a single Environment.

  • name: Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`.

func (*ProjectsLocationsEnvironmentsService) List 

func (r *ProjectsLocationsEnvironmentsService) List(parent string) *ProjectsLocationsEnvironmentsListCall

List: Lists environments in a project.

- parent: Format: `projects/{project_id}/locations/{location}`.

type ProjectsLocationsExecutionsCreateCall added in v0.38.0 

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

func (*ProjectsLocationsExecutionsCreateCall) Context added in v0.38.0 

func (c *ProjectsLocationsExecutionsCreateCall) Context(ctx context.Context) *ProjectsLocationsExecutionsCreateCall

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

func (*ProjectsLocationsExecutionsCreateCall) Do added in v0.38.0 

func (c *ProjectsLocationsExecutionsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.executions.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 (*ProjectsLocationsExecutionsCreateCall) ExecutionId added in v0.38.0 

func (c *ProjectsLocationsExecutionsCreateCall) ExecutionId(executionId string) *ProjectsLocationsExecutionsCreateCall

ExecutionId sets the optional parameter "executionId": Required. User-defined unique ID of this execution.

func (*ProjectsLocationsExecutionsCreateCall) Fields added in v0.38.0 

func (c *ProjectsLocationsExecutionsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsExecutionsCreateCall

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

func (*ProjectsLocationsExecutionsCreateCall) Header added in v0.38.0 

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

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

type ProjectsLocationsExecutionsDeleteCall added in v0.38.0 

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

func (*ProjectsLocationsExecutionsDeleteCall) Context added in v0.38.0 

func (c *ProjectsLocationsExecutionsDeleteCall) Context(ctx context.Context) *ProjectsLocationsExecutionsDeleteCall

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

func (*ProjectsLocationsExecutionsDeleteCall) Do added in v0.38.0 

func (c *ProjectsLocationsExecutionsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.executions.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 (*ProjectsLocationsExecutionsDeleteCall) Fields added in v0.38.0 

func (c *ProjectsLocationsExecutionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsExecutionsDeleteCall

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

func (*ProjectsLocationsExecutionsDeleteCall) Header added in v0.38.0 

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

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

type ProjectsLocationsExecutionsGetCall added in v0.38.0 

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

func (*ProjectsLocationsExecutionsGetCall) Context added in v0.38.0 

func (c *ProjectsLocationsExecutionsGetCall) Context(ctx context.Context) *ProjectsLocationsExecutionsGetCall

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

func (*ProjectsLocationsExecutionsGetCall) Do added in v0.38.0 

func (c *ProjectsLocationsExecutionsGetCall) Do(opts ...googleapi.CallOption) (*Execution, error)

Do executes the "notebooks.projects.locations.executions.get" call. Any non-2xx status code is an error. Response headers are in either *Execution.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 (*ProjectsLocationsExecutionsGetCall) Fields added in v0.38.0 

func (c *ProjectsLocationsExecutionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsExecutionsGetCall

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

func (*ProjectsLocationsExecutionsGetCall) Header added in v0.38.0 

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

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

func (*ProjectsLocationsExecutionsGetCall) IfNoneMatch added in v0.38.0 

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

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 ProjectsLocationsExecutionsListCall added in v0.38.0 

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

func (*ProjectsLocationsExecutionsListCall) Context added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) Context(ctx context.Context) *ProjectsLocationsExecutionsListCall

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

func (*ProjectsLocationsExecutionsListCall) Do added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListExecutionsResponse, error)

Do executes the "notebooks.projects.locations.executions.list" call. Any non-2xx status code is an error. Response headers are in either *ListExecutionsResponse.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 (*ProjectsLocationsExecutionsListCall) Fields added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsExecutionsListCall

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

func (*ProjectsLocationsExecutionsListCall) Filter added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) Filter(filter string) *ProjectsLocationsExecutionsListCall

Filter sets the optional parameter "filter": Filter applied to resulting executions. Currently only supports filtering executions by a specified `schedule_id`. Format: `schedule_id=`

func (*ProjectsLocationsExecutionsListCall) Header added in v0.38.0 

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

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

func (*ProjectsLocationsExecutionsListCall) IfNoneMatch added in v0.38.0 

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

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 (*ProjectsLocationsExecutionsListCall) OrderBy added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) OrderBy(orderBy string) *ProjectsLocationsExecutionsListCall

OrderBy sets the optional parameter "orderBy": Sort by field.

func (*ProjectsLocationsExecutionsListCall) PageSize added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) PageSize(pageSize int64) *ProjectsLocationsExecutionsListCall

PageSize sets the optional parameter "pageSize": Maximum return size of the list call.

func (*ProjectsLocationsExecutionsListCall) PageToken added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) PageToken(pageToken string) *ProjectsLocationsExecutionsListCall

PageToken sets the optional parameter "pageToken": A previous returned page token that can be used to continue listing from the last result.

func (*ProjectsLocationsExecutionsListCall) Pages added in v0.38.0 

func (c *ProjectsLocationsExecutionsListCall) Pages(ctx context.Context, f func(*ListExecutionsResponse) error) error

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 ProjectsLocationsExecutionsService added in v0.38.0 

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

func NewProjectsLocationsExecutionsService added in v0.38.0 

func NewProjectsLocationsExecutionsService(s *Service) *ProjectsLocationsExecutionsService

func (*ProjectsLocationsExecutionsService) Create added in v0.38.0 

func (r *ProjectsLocationsExecutionsService) Create(parent string, execution *Execution) *ProjectsLocationsExecutionsCreateCall

Create: Creates a new Execution in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsExecutionsService) Delete added in v0.38.0 

func (r *ProjectsLocationsExecutionsService) Delete(name string) *ProjectsLocationsExecutionsDeleteCall

Delete: Deletes execution

  • name: Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`.

func (*ProjectsLocationsExecutionsService) Get added in v0.38.0 

func (r *ProjectsLocationsExecutionsService) Get(name string) *ProjectsLocationsExecutionsGetCall

Get: Gets details of executions

  • name: Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`.

func (*ProjectsLocationsExecutionsService) List added in v0.38.0 

func (r *ProjectsLocationsExecutionsService) List(parent string) *ProjectsLocationsExecutionsListCall

List: Lists executions in a given project and location

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

type ProjectsLocationsGetCall 

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

func (*ProjectsLocationsGetCall) Context 

func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall) Do 

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "notebooks.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 

func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall

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 ProjectsLocationsInstancesCreateCall 

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

func (*ProjectsLocationsInstancesCreateCall) Context 

func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesCreateCall

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

func (*ProjectsLocationsInstancesCreateCall) Do 

func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesCreateCall) Fields 

func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall

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

func (*ProjectsLocationsInstancesCreateCall) Header 

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

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

func (*ProjectsLocationsInstancesCreateCall) InstanceId 

func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceId string) *ProjectsLocationsInstancesCreateCall

InstanceId sets the optional parameter "instanceId": Required. User-defined unique ID of this instance.

type ProjectsLocationsInstancesDeleteCall 

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

func (*ProjectsLocationsInstancesDeleteCall) Context 

func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesDeleteCall

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

func (*ProjectsLocationsInstancesDeleteCall) Do 

func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesDeleteCall) Fields 

func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall

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

func (*ProjectsLocationsInstancesDeleteCall) Header 

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

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

type ProjectsLocationsInstancesDiagnoseCall added in v0.100.0 

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

func (*ProjectsLocationsInstancesDiagnoseCall) Context added in v0.100.0 

func (c *ProjectsLocationsInstancesDiagnoseCall) Context(ctx context.Context) *ProjectsLocationsInstancesDiagnoseCall

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

func (*ProjectsLocationsInstancesDiagnoseCall) Do added in v0.100.0 

func (c *ProjectsLocationsInstancesDiagnoseCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.diagnose" 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 (*ProjectsLocationsInstancesDiagnoseCall) Fields added in v0.100.0 

func (c *ProjectsLocationsInstancesDiagnoseCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDiagnoseCall

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

func (*ProjectsLocationsInstancesDiagnoseCall) Header added in v0.100.0 

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

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

type ProjectsLocationsInstancesGetCall 

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

func (*ProjectsLocationsInstancesGetCall) Context 

func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetCall

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

func (*ProjectsLocationsInstancesGetCall) Do 

func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance, error)

Do executes the "notebooks.projects.locations.instances.get" call. Any non-2xx status code is an error. Response headers are in either *Instance.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 (*ProjectsLocationsInstancesGetCall) Fields 

func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall

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

func (*ProjectsLocationsInstancesGetCall) Header 

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

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

func (*ProjectsLocationsInstancesGetCall) IfNoneMatch 

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

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 ProjectsLocationsInstancesGetIamPolicyCall 

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

func (*ProjectsLocationsInstancesGetIamPolicyCall) Context 

func (c *ProjectsLocationsInstancesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetIamPolicyCall

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

func (*ProjectsLocationsInstancesGetIamPolicyCall) Do 

func (c *ProjectsLocationsInstancesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesGetIamPolicyCall) Fields 

func (c *ProjectsLocationsInstancesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetIamPolicyCall

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

func (*ProjectsLocationsInstancesGetIamPolicyCall) Header 

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

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

func (*ProjectsLocationsInstancesGetIamPolicyCall) IfNoneMatch 

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

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 (*ProjectsLocationsInstancesGetIamPolicyCall) OptionsRequestedPolicyVersion 

func (c *ProjectsLocationsInstancesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsInstancesGetIamPolicyCall

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 ProjectsLocationsInstancesGetInstanceHealthCall added in v0.37.0 

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

func (*ProjectsLocationsInstancesGetInstanceHealthCall) Context added in v0.37.0 

func (c *ProjectsLocationsInstancesGetInstanceHealthCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetInstanceHealthCall

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

func (*ProjectsLocationsInstancesGetInstanceHealthCall) Do added in v0.37.0 

func (c *ProjectsLocationsInstancesGetInstanceHealthCall) Do(opts ...googleapi.CallOption) (*GetInstanceHealthResponse, error)

Do executes the "notebooks.projects.locations.instances.getInstanceHealth" call. Any non-2xx status code is an error. Response headers are in either *GetInstanceHealthResponse.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 (*ProjectsLocationsInstancesGetInstanceHealthCall) Fields added in v0.37.0 

func (c *ProjectsLocationsInstancesGetInstanceHealthCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetInstanceHealthCall

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

func (*ProjectsLocationsInstancesGetInstanceHealthCall) Header added in v0.37.0 

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

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

func (*ProjectsLocationsInstancesGetInstanceHealthCall) IfNoneMatch added in v0.37.0 

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

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 ProjectsLocationsInstancesIsUpgradeableCall 

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

func (*ProjectsLocationsInstancesIsUpgradeableCall) Context 

func (c *ProjectsLocationsInstancesIsUpgradeableCall) Context(ctx context.Context) *ProjectsLocationsInstancesIsUpgradeableCall

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

func (*ProjectsLocationsInstancesIsUpgradeableCall) Do 

func (c *ProjectsLocationsInstancesIsUpgradeableCall) Do(opts ...googleapi.CallOption) (*IsInstanceUpgradeableResponse, error)

Do executes the "notebooks.projects.locations.instances.isUpgradeable" call. Any non-2xx status code is an error. Response headers are in either *IsInstanceUpgradeableResponse.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 (*ProjectsLocationsInstancesIsUpgradeableCall) Fields 

func (c *ProjectsLocationsInstancesIsUpgradeableCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesIsUpgradeableCall

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

func (*ProjectsLocationsInstancesIsUpgradeableCall) Header 

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

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

func (*ProjectsLocationsInstancesIsUpgradeableCall) IfNoneMatch 

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

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 (*ProjectsLocationsInstancesIsUpgradeableCall) Type added in v0.65.0 

func (c *ProjectsLocationsInstancesIsUpgradeableCall) Type(type_ string) *ProjectsLocationsInstancesIsUpgradeableCall

Type sets the optional parameter "type": The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.

Possible values: 

"UPGRADE_TYPE_UNSPECIFIED" - Upgrade type is not specified.
"UPGRADE_FRAMEWORK" - Upgrade ML framework.
"UPGRADE_OS" - Upgrade Operating System.
"UPGRADE_CUDA" - Upgrade CUDA.
"UPGRADE_ALL" - Upgrade All (OS, Framework and CUDA).

type ProjectsLocationsInstancesListCall 

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

func (*ProjectsLocationsInstancesListCall) Context 

func (c *ProjectsLocationsInstancesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesListCall

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

func (*ProjectsLocationsInstancesListCall) Do 

func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)

Do executes the "notebooks.projects.locations.instances.list" call. Any non-2xx status code is an error. Response headers are in either *ListInstancesResponse.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 (*ProjectsLocationsInstancesListCall) Fields 

func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall

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

func (*ProjectsLocationsInstancesListCall) Filter added in v0.142.0 

func (c *ProjectsLocationsInstancesListCall) Filter(filter string) *ProjectsLocationsInstancesListCall

Filter sets the optional parameter "filter": List filter.

func (*ProjectsLocationsInstancesListCall) Header 

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

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

func (*ProjectsLocationsInstancesListCall) IfNoneMatch 

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

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 (*ProjectsLocationsInstancesListCall) OrderBy added in v0.142.0 

func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsInstancesListCall) PageSize 

func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall

PageSize sets the optional parameter "pageSize": Maximum return size of the list call.

func (*ProjectsLocationsInstancesListCall) PageToken 

func (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall

PageToken sets the optional parameter "pageToken": A previous returned page token that can be used to continue listing from the last result.

func (*ProjectsLocationsInstancesListCall) Pages 

func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error

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 ProjectsLocationsInstancesMigrateCall added in v0.148.0 

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

func (*ProjectsLocationsInstancesMigrateCall) Context added in v0.148.0 

func (c *ProjectsLocationsInstancesMigrateCall) Context(ctx context.Context) *ProjectsLocationsInstancesMigrateCall

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

func (*ProjectsLocationsInstancesMigrateCall) Do added in v0.148.0 

func (c *ProjectsLocationsInstancesMigrateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.migrate" 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 (*ProjectsLocationsInstancesMigrateCall) Fields added in v0.148.0 

func (c *ProjectsLocationsInstancesMigrateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesMigrateCall

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

func (*ProjectsLocationsInstancesMigrateCall) Header added in v0.148.0 

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

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

type ProjectsLocationsInstancesRegisterCall 

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

func (*ProjectsLocationsInstancesRegisterCall) Context 

func (c *ProjectsLocationsInstancesRegisterCall) Context(ctx context.Context) *ProjectsLocationsInstancesRegisterCall

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

func (*ProjectsLocationsInstancesRegisterCall) Do 

func (c *ProjectsLocationsInstancesRegisterCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.register" 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 (*ProjectsLocationsInstancesRegisterCall) Fields 

func (c *ProjectsLocationsInstancesRegisterCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRegisterCall

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

func (*ProjectsLocationsInstancesRegisterCall) Header 

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

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

type ProjectsLocationsInstancesReportCall 

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

func (*ProjectsLocationsInstancesReportCall) Context 

func (c *ProjectsLocationsInstancesReportCall) Context(ctx context.Context) *ProjectsLocationsInstancesReportCall

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

func (*ProjectsLocationsInstancesReportCall) Do 

func (c *ProjectsLocationsInstancesReportCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.report" 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 (*ProjectsLocationsInstancesReportCall) Fields 

func (c *ProjectsLocationsInstancesReportCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesReportCall

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

func (*ProjectsLocationsInstancesReportCall) Header 

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

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

type ProjectsLocationsInstancesReportEventCall added in v0.109.0 

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

func (*ProjectsLocationsInstancesReportEventCall) Context added in v0.109.0 

func (c *ProjectsLocationsInstancesReportEventCall) Context(ctx context.Context) *ProjectsLocationsInstancesReportEventCall

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

func (*ProjectsLocationsInstancesReportEventCall) Do added in v0.109.0 

func (c *ProjectsLocationsInstancesReportEventCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.reportEvent" 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 (*ProjectsLocationsInstancesReportEventCall) Fields added in v0.109.0 

func (c *ProjectsLocationsInstancesReportEventCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesReportEventCall

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

func (*ProjectsLocationsInstancesReportEventCall) Header added in v0.109.0 

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

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

type ProjectsLocationsInstancesResetCall 

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

func (*ProjectsLocationsInstancesResetCall) Context 

func (c *ProjectsLocationsInstancesResetCall) Context(ctx context.Context) *ProjectsLocationsInstancesResetCall

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

func (*ProjectsLocationsInstancesResetCall) Do 

func (c *ProjectsLocationsInstancesResetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.reset" 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 (*ProjectsLocationsInstancesResetCall) Fields 

func (c *ProjectsLocationsInstancesResetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesResetCall

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

func (*ProjectsLocationsInstancesResetCall) Header 

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

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

type ProjectsLocationsInstancesRollbackCall added in v0.45.0 

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

func (*ProjectsLocationsInstancesRollbackCall) Context added in v0.45.0 

func (c *ProjectsLocationsInstancesRollbackCall) Context(ctx context.Context) *ProjectsLocationsInstancesRollbackCall

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

func (*ProjectsLocationsInstancesRollbackCall) Do added in v0.45.0 

func (c *ProjectsLocationsInstancesRollbackCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.rollback" 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 (*ProjectsLocationsInstancesRollbackCall) Fields added in v0.45.0 

func (c *ProjectsLocationsInstancesRollbackCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRollbackCall

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

func (*ProjectsLocationsInstancesRollbackCall) Header added in v0.45.0 

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

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

type ProjectsLocationsInstancesService 

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

func NewProjectsLocationsInstancesService 

func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService

func (*ProjectsLocationsInstancesService) Create 

func (r *ProjectsLocationsInstancesService) Create(parent string, instance *Instance) *ProjectsLocationsInstancesCreateCall

Create: Creates a new Instance in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsInstancesService) Delete 

func (r *ProjectsLocationsInstancesService) Delete(name string) *ProjectsLocationsInstancesDeleteCall

Delete: Deletes a single Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Diagnose added in v0.100.0 

func (r *ProjectsLocationsInstancesService) Diagnose(name string, diagnoseinstancerequest *DiagnoseInstanceRequest) *ProjectsLocationsInstancesDiagnoseCall

Diagnose: Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Get 

func (r *ProjectsLocationsInstancesService) Get(name string) *ProjectsLocationsInstancesGetCall

Get: Gets details of a single Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) GetIamPolicy 

func (r *ProjectsLocationsInstancesService) GetIamPolicy(resource string) *ProjectsLocationsInstancesGetIamPolicyCall

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 (*ProjectsLocationsInstancesService) GetInstanceHealth added in v0.37.0 

func (r *ProjectsLocationsInstancesService) GetInstanceHealth(name string) *ProjectsLocationsInstancesGetInstanceHealthCall

GetInstanceHealth: Checks whether a notebook instance is healthy.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) IsUpgradeable 

func (r *ProjectsLocationsInstancesService) IsUpgradeable(notebookInstance string) *ProjectsLocationsInstancesIsUpgradeableCall

IsUpgradeable: Checks whether a notebook instance is upgradable.

  • notebookInstance: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) List 

func (r *ProjectsLocationsInstancesService) List(parent string) *ProjectsLocationsInstancesListCall

List: Lists instances in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsInstancesService) Migrate added in v0.148.0 

func (r *ProjectsLocationsInstancesService) Migrate(name string, migrateinstancerequest *MigrateInstanceRequest) *ProjectsLocationsInstancesMigrateCall

Migrate: Migrates an existing User-Managed Notebook to Workbench Instances.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Register 

func (r *ProjectsLocationsInstancesService) Register(parent string, registerinstancerequest *RegisterInstanceRequest) *ProjectsLocationsInstancesRegisterCall

Register: Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsInstancesService) Report 

func (r *ProjectsLocationsInstancesService) Report(name string, reportinstanceinforequest *ReportInstanceInfoRequest) *ProjectsLocationsInstancesReportCall

Report: Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) ReportEvent added in v0.109.0 

func (r *ProjectsLocationsInstancesService) ReportEvent(name string, reportinstanceeventrequest *ReportInstanceEventRequest) *ProjectsLocationsInstancesReportEventCall

ReportEvent: Reports and processes an instance event.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Reset 

func (r *ProjectsLocationsInstancesService) Reset(name string, resetinstancerequest *ResetInstanceRequest) *ProjectsLocationsInstancesResetCall

Reset: Resets a notebook instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Rollback added in v0.45.0 

func (r *ProjectsLocationsInstancesService) Rollback(name string, rollbackinstancerequest *RollbackInstanceRequest) *ProjectsLocationsInstancesRollbackCall

Rollback: Rollbacks a notebook instance to the previous version.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) SetAccelerator 

func (r *ProjectsLocationsInstancesService) SetAccelerator(name string, setinstanceacceleratorrequest *SetInstanceAcceleratorRequest) *ProjectsLocationsInstancesSetAcceleratorCall

SetAccelerator: Updates the guest accelerators of a single Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) SetIamPolicy 

func (r *ProjectsLocationsInstancesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsInstancesSetIamPolicyCall

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 (*ProjectsLocationsInstancesService) SetLabels 

func (r *ProjectsLocationsInstancesService) SetLabels(name string, setinstancelabelsrequest *SetInstanceLabelsRequest) *ProjectsLocationsInstancesSetLabelsCall

SetLabels: Replaces all the labels of an Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) SetMachineType 

func (r *ProjectsLocationsInstancesService) SetMachineType(name string, setinstancemachinetyperequest *SetInstanceMachineTypeRequest) *ProjectsLocationsInstancesSetMachineTypeCall

SetMachineType: Updates the machine type of a single Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Start 

func (r *ProjectsLocationsInstancesService) Start(name string, startinstancerequest *StartInstanceRequest) *ProjectsLocationsInstancesStartCall

Start: Starts a notebook instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Stop 

func (r *ProjectsLocationsInstancesService) Stop(name string, stopinstancerequest *StopInstanceRequest) *ProjectsLocationsInstancesStopCall

Stop: Stops a notebook instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) TestIamPermissions 

func (r *ProjectsLocationsInstancesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsInstancesTestIamPermissionsCall

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.

func (*ProjectsLocationsInstancesService) UpdateConfig added in v0.49.0 

func (r *ProjectsLocationsInstancesService) UpdateConfig(name string, updateinstanceconfigrequest *UpdateInstanceConfigRequest) *ProjectsLocationsInstancesUpdateConfigCall

UpdateConfig: Update Notebook Instance configurations.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) UpdateMetadataItems added in v0.65.0 

func (r *ProjectsLocationsInstancesService) UpdateMetadataItems(name string, updateinstancemetadataitemsrequest *UpdateInstanceMetadataItemsRequest) *ProjectsLocationsInstancesUpdateMetadataItemsCall

UpdateMetadataItems: Add/update metadata items for an instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) UpdateShieldedInstanceConfig added in v0.44.0 

func (r *ProjectsLocationsInstancesService) UpdateShieldedInstanceConfig(name string, updateshieldedinstanceconfigrequest *UpdateShieldedInstanceConfigRequest) *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall

UpdateShieldedInstanceConfig: Updates the Shielded instance configuration of a single Instance.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Upgrade 

func (r *ProjectsLocationsInstancesService) Upgrade(name string, upgradeinstancerequest *UpgradeInstanceRequest) *ProjectsLocationsInstancesUpgradeCall

Upgrade: Upgrades a notebook instance to the latest version.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) UpgradeInternal 

func (r *ProjectsLocationsInstancesService) UpgradeInternal(name string, upgradeinstanceinternalrequest *UpgradeInstanceInternalRequest) *ProjectsLocationsInstancesUpgradeInternalCall

UpgradeInternal: Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

  • name: Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`.

type ProjectsLocationsInstancesSetAcceleratorCall 

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

func (*ProjectsLocationsInstancesSetAcceleratorCall) Context 

func (c *ProjectsLocationsInstancesSetAcceleratorCall) Context(ctx context.Context) *ProjectsLocationsInstancesSetAcceleratorCall

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

func (*ProjectsLocationsInstancesSetAcceleratorCall) Do 

func (c *ProjectsLocationsInstancesSetAcceleratorCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.setAccelerator" 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 (*ProjectsLocationsInstancesSetAcceleratorCall) Fields 

func (c *ProjectsLocationsInstancesSetAcceleratorCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSetAcceleratorCall

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

func (*ProjectsLocationsInstancesSetAcceleratorCall) Header 

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

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

type ProjectsLocationsInstancesSetIamPolicyCall 

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

func (*ProjectsLocationsInstancesSetIamPolicyCall) Context 

func (c *ProjectsLocationsInstancesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsInstancesSetIamPolicyCall

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

func (*ProjectsLocationsInstancesSetIamPolicyCall) Do 

func (c *ProjectsLocationsInstancesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesSetIamPolicyCall) Fields 

func (c *ProjectsLocationsInstancesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSetIamPolicyCall

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

func (*ProjectsLocationsInstancesSetIamPolicyCall) Header 

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

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

type ProjectsLocationsInstancesSetLabelsCall 

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

func (*ProjectsLocationsInstancesSetLabelsCall) Context 

func (c *ProjectsLocationsInstancesSetLabelsCall) Context(ctx context.Context) *ProjectsLocationsInstancesSetLabelsCall

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

func (*ProjectsLocationsInstancesSetLabelsCall) Do 

func (c *ProjectsLocationsInstancesSetLabelsCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.setLabels" 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 (*ProjectsLocationsInstancesSetLabelsCall) Fields 

func (c *ProjectsLocationsInstancesSetLabelsCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSetLabelsCall

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

func (*ProjectsLocationsInstancesSetLabelsCall) Header 

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

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

type ProjectsLocationsInstancesSetMachineTypeCall 

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

func (*ProjectsLocationsInstancesSetMachineTypeCall) Context 

func (c *ProjectsLocationsInstancesSetMachineTypeCall) Context(ctx context.Context) *ProjectsLocationsInstancesSetMachineTypeCall

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

func (*ProjectsLocationsInstancesSetMachineTypeCall) Do 

func (c *ProjectsLocationsInstancesSetMachineTypeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.setMachineType" 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 (*ProjectsLocationsInstancesSetMachineTypeCall) Fields 

func (c *ProjectsLocationsInstancesSetMachineTypeCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSetMachineTypeCall

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

func (*ProjectsLocationsInstancesSetMachineTypeCall) Header 

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

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

type ProjectsLocationsInstancesStartCall 

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

func (*ProjectsLocationsInstancesStartCall) Context 

func (c *ProjectsLocationsInstancesStartCall) Context(ctx context.Context) *ProjectsLocationsInstancesStartCall

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

func (*ProjectsLocationsInstancesStartCall) Do 

func (c *ProjectsLocationsInstancesStartCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesStartCall) Fields 

func (c *ProjectsLocationsInstancesStartCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesStartCall

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

func (*ProjectsLocationsInstancesStartCall) Header 

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

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

type ProjectsLocationsInstancesStopCall 

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

func (*ProjectsLocationsInstancesStopCall) Context 

func (c *ProjectsLocationsInstancesStopCall) Context(ctx context.Context) *ProjectsLocationsInstancesStopCall

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

func (*ProjectsLocationsInstancesStopCall) Do 

func (c *ProjectsLocationsInstancesStopCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesStopCall) Fields 

func (c *ProjectsLocationsInstancesStopCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesStopCall

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

func (*ProjectsLocationsInstancesStopCall) Header 

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

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

type ProjectsLocationsInstancesTestIamPermissionsCall 

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

func (*ProjectsLocationsInstancesTestIamPermissionsCall) Context 

func (c *ProjectsLocationsInstancesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsInstancesTestIamPermissionsCall

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

func (*ProjectsLocationsInstancesTestIamPermissionsCall) Do 

func (c *ProjectsLocationsInstancesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "notebooks.projects.locations.instances.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 (*ProjectsLocationsInstancesTestIamPermissionsCall) Fields 

func (c *ProjectsLocationsInstancesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesTestIamPermissionsCall

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

func (*ProjectsLocationsInstancesTestIamPermissionsCall) Header 

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

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

type ProjectsLocationsInstancesUpdateConfigCall added in v0.49.0 

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

func (*ProjectsLocationsInstancesUpdateConfigCall) Context added in v0.49.0 

func (c *ProjectsLocationsInstancesUpdateConfigCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpdateConfigCall

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

func (*ProjectsLocationsInstancesUpdateConfigCall) Do added in v0.49.0 

func (c *ProjectsLocationsInstancesUpdateConfigCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.updateConfig" 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 (*ProjectsLocationsInstancesUpdateConfigCall) Fields added in v0.49.0 

func (c *ProjectsLocationsInstancesUpdateConfigCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpdateConfigCall

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

func (*ProjectsLocationsInstancesUpdateConfigCall) Header added in v0.49.0 

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

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

type ProjectsLocationsInstancesUpdateMetadataItemsCall added in v0.65.0 

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

func (*ProjectsLocationsInstancesUpdateMetadataItemsCall) Context added in v0.65.0 

func (c *ProjectsLocationsInstancesUpdateMetadataItemsCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpdateMetadataItemsCall

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

func (*ProjectsLocationsInstancesUpdateMetadataItemsCall) Do added in v0.65.0 

func (c *ProjectsLocationsInstancesUpdateMetadataItemsCall) Do(opts ...googleapi.CallOption) (*UpdateInstanceMetadataItemsResponse, error)

Do executes the "notebooks.projects.locations.instances.updateMetadataItems" call. Any non-2xx status code is an error. Response headers are in either *UpdateInstanceMetadataItemsResponse.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 (*ProjectsLocationsInstancesUpdateMetadataItemsCall) Fields added in v0.65.0 

func (c *ProjectsLocationsInstancesUpdateMetadataItemsCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpdateMetadataItemsCall

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

func (*ProjectsLocationsInstancesUpdateMetadataItemsCall) Header added in v0.65.0 

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

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

type ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall added in v0.44.0 

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

func (*ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Context added in v0.44.0 

func (c *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall

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

func (*ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Do added in v0.44.0 

func (c *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.updateShieldedInstanceConfig" 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 (*ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Fields added in v0.44.0 

func (c *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall

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

func (*ProjectsLocationsInstancesUpdateShieldedInstanceConfigCall) Header added in v0.44.0 

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

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

type ProjectsLocationsInstancesUpgradeCall 

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

func (*ProjectsLocationsInstancesUpgradeCall) Context 

func (c *ProjectsLocationsInstancesUpgradeCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpgradeCall

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

func (*ProjectsLocationsInstancesUpgradeCall) Do 

func (c *ProjectsLocationsInstancesUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.upgrade" 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 (*ProjectsLocationsInstancesUpgradeCall) Fields 

func (c *ProjectsLocationsInstancesUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpgradeCall

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

func (*ProjectsLocationsInstancesUpgradeCall) Header 

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

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

type ProjectsLocationsInstancesUpgradeInternalCall 

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

func (*ProjectsLocationsInstancesUpgradeInternalCall) Context 

func (c *ProjectsLocationsInstancesUpgradeInternalCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpgradeInternalCall

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

func (*ProjectsLocationsInstancesUpgradeInternalCall) Do 

func (c *ProjectsLocationsInstancesUpgradeInternalCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.instances.upgradeInternal" 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 (*ProjectsLocationsInstancesUpgradeInternalCall) Fields 

func (c *ProjectsLocationsInstancesUpgradeInternalCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpgradeInternalCall

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

func (*ProjectsLocationsInstancesUpgradeInternalCall) Header 

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

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

type ProjectsLocationsListCall 

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

func (*ProjectsLocationsListCall) Context 

func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Do 

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)

Do executes the "notebooks.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 

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Filter 

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

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 

func (c *ProjectsLocationsListCall) Header() http.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 

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) PageToken 

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

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 

func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error

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 

func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall) Do 

func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "notebooks.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 

func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall) Header 

func (c *ProjectsLocationsOperationsCancelCall) Header() http.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 

func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall) Do 

func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "notebooks.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 

func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall) Header 

func (c *ProjectsLocationsOperationsDeleteCall) Header() http.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 

func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall) Do 

func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.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 

func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall) Header 

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

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

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch 

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

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 

func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Do 

func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "notebooks.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 

func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Filter 

func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Header 

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

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

func (*ProjectsLocationsOperationsListCall) IfNoneMatch 

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

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 

func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) PageToken 

func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Pages 

func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

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 

func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall

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 

func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall

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 

func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall

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 

func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall

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 ProjectsLocationsRuntimesCreateCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesCreateCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesCreateCall) Context(ctx context.Context) *ProjectsLocationsRuntimesCreateCall

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

func (*ProjectsLocationsRuntimesCreateCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesCreateCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesCreateCall

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

func (*ProjectsLocationsRuntimesCreateCall) Header added in v0.44.0 

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

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

func (*ProjectsLocationsRuntimesCreateCall) RequestId added in v0.73.0 

func (c *ProjectsLocationsRuntimesCreateCall) RequestId(requestId string) *ProjectsLocationsRuntimesCreateCall

RequestId sets the optional parameter "requestId": Idempotent request UUID.

func (*ProjectsLocationsRuntimesCreateCall) RuntimeId added in v0.44.0 

func (c *ProjectsLocationsRuntimesCreateCall) RuntimeId(runtimeId string) *ProjectsLocationsRuntimesCreateCall

RuntimeId sets the optional parameter "runtimeId": Required. User-defined unique ID of this Runtime.

type ProjectsLocationsRuntimesDeleteCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesDeleteCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesDeleteCall) Context(ctx context.Context) *ProjectsLocationsRuntimesDeleteCall

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

func (*ProjectsLocationsRuntimesDeleteCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesDeleteCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesDeleteCall

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

func (*ProjectsLocationsRuntimesDeleteCall) Header added in v0.44.0 

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

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

func (*ProjectsLocationsRuntimesDeleteCall) RequestId added in v0.73.0 

func (c *ProjectsLocationsRuntimesDeleteCall) RequestId(requestId string) *ProjectsLocationsRuntimesDeleteCall

RequestId sets the optional parameter "requestId": Idempotent request UUID.

type ProjectsLocationsRuntimesDiagnoseCall added in v0.100.0 

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

func (*ProjectsLocationsRuntimesDiagnoseCall) Context added in v0.100.0 

func (c *ProjectsLocationsRuntimesDiagnoseCall) Context(ctx context.Context) *ProjectsLocationsRuntimesDiagnoseCall

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

func (*ProjectsLocationsRuntimesDiagnoseCall) Do added in v0.100.0 

func (c *ProjectsLocationsRuntimesDiagnoseCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.diagnose" 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 (*ProjectsLocationsRuntimesDiagnoseCall) Fields added in v0.100.0 

func (c *ProjectsLocationsRuntimesDiagnoseCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesDiagnoseCall

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

func (*ProjectsLocationsRuntimesDiagnoseCall) Header added in v0.100.0 

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

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

type ProjectsLocationsRuntimesGetCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesGetCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesGetCall) Context(ctx context.Context) *ProjectsLocationsRuntimesGetCall

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

func (*ProjectsLocationsRuntimesGetCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesGetCall) Do(opts ...googleapi.CallOption) (*Runtime, error)

Do executes the "notebooks.projects.locations.runtimes.get" call. Any non-2xx status code is an error. Response headers are in either *Runtime.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 (*ProjectsLocationsRuntimesGetCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesGetCall

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

func (*ProjectsLocationsRuntimesGetCall) Header added in v0.44.0 

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

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

func (*ProjectsLocationsRuntimesGetCall) IfNoneMatch added in v0.44.0 

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

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 ProjectsLocationsRuntimesGetIamPolicyCall added in v0.60.0 

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

func (*ProjectsLocationsRuntimesGetIamPolicyCall) Context added in v0.60.0 

func (c *ProjectsLocationsRuntimesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsRuntimesGetIamPolicyCall

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

func (*ProjectsLocationsRuntimesGetIamPolicyCall) Do added in v0.60.0 

func (c *ProjectsLocationsRuntimesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesGetIamPolicyCall) Fields added in v0.60.0 

func (c *ProjectsLocationsRuntimesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesGetIamPolicyCall

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

func (*ProjectsLocationsRuntimesGetIamPolicyCall) Header added in v0.60.0 

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

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

func (*ProjectsLocationsRuntimesGetIamPolicyCall) IfNoneMatch added in v0.60.0 

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

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 (*ProjectsLocationsRuntimesGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.60.0 

func (c *ProjectsLocationsRuntimesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsRuntimesGetIamPolicyCall

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 ProjectsLocationsRuntimesListCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesListCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) Context(ctx context.Context) *ProjectsLocationsRuntimesListCall

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

func (*ProjectsLocationsRuntimesListCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) Do(opts ...googleapi.CallOption) (*ListRuntimesResponse, error)

Do executes the "notebooks.projects.locations.runtimes.list" call. Any non-2xx status code is an error. Response headers are in either *ListRuntimesResponse.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 (*ProjectsLocationsRuntimesListCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesListCall

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

func (*ProjectsLocationsRuntimesListCall) Filter added in v0.142.0 

func (c *ProjectsLocationsRuntimesListCall) Filter(filter string) *ProjectsLocationsRuntimesListCall

Filter sets the optional parameter "filter": List filter.

func (*ProjectsLocationsRuntimesListCall) Header added in v0.44.0 

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

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

func (*ProjectsLocationsRuntimesListCall) IfNoneMatch added in v0.44.0 

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

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 (*ProjectsLocationsRuntimesListCall) OrderBy added in v0.142.0 

func (c *ProjectsLocationsRuntimesListCall) OrderBy(orderBy string) *ProjectsLocationsRuntimesListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsRuntimesListCall) PageSize added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) PageSize(pageSize int64) *ProjectsLocationsRuntimesListCall

PageSize sets the optional parameter "pageSize": Maximum return size of the list call.

func (*ProjectsLocationsRuntimesListCall) PageToken added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) PageToken(pageToken string) *ProjectsLocationsRuntimesListCall

PageToken sets the optional parameter "pageToken": A previous returned page token that can be used to continue listing from the last result.

func (*ProjectsLocationsRuntimesListCall) Pages added in v0.44.0 

func (c *ProjectsLocationsRuntimesListCall) Pages(ctx context.Context, f func(*ListRuntimesResponse) error) error

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 ProjectsLocationsRuntimesMigrateCall added in v0.148.0 

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

func (*ProjectsLocationsRuntimesMigrateCall) Context added in v0.148.0 

func (c *ProjectsLocationsRuntimesMigrateCall) Context(ctx context.Context) *ProjectsLocationsRuntimesMigrateCall

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

func (*ProjectsLocationsRuntimesMigrateCall) Do added in v0.148.0 

func (c *ProjectsLocationsRuntimesMigrateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.migrate" 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 (*ProjectsLocationsRuntimesMigrateCall) Fields added in v0.148.0 

func (c *ProjectsLocationsRuntimesMigrateCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesMigrateCall

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

func (*ProjectsLocationsRuntimesMigrateCall) Header added in v0.148.0 

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

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

type ProjectsLocationsRuntimesPatchCall added in v0.81.0 

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

func (*ProjectsLocationsRuntimesPatchCall) Context added in v0.81.0 

func (c *ProjectsLocationsRuntimesPatchCall) Context(ctx context.Context) *ProjectsLocationsRuntimesPatchCall

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

func (*ProjectsLocationsRuntimesPatchCall) Do added in v0.81.0 

func (c *ProjectsLocationsRuntimesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesPatchCall) Fields added in v0.81.0 

func (c *ProjectsLocationsRuntimesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesPatchCall

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

func (*ProjectsLocationsRuntimesPatchCall) Header added in v0.81.0 

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

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

func (*ProjectsLocationsRuntimesPatchCall) RequestId added in v0.81.0 

func (c *ProjectsLocationsRuntimesPatchCall) RequestId(requestId string) *ProjectsLocationsRuntimesPatchCall

RequestId sets the optional parameter "requestId": Idempotent request UUID.

func (*ProjectsLocationsRuntimesPatchCall) UpdateMask added in v0.81.0 

func (c *ProjectsLocationsRuntimesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsRuntimesPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Specifies the path, relative to `Runtime`, of the field to update. For example, to change the software configuration kernels, the `update_mask` parameter would be specified as `software_config.kernels`, and the `PATCH` request body would specify the new value, as follows: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Currently, only the following fields can be updated: - `software_config.kernels` - `software_config.post_startup_script` - `software_config.custom_gpu_driver_path` - `software_config.idle_shutdown` - `software_config.idle_shutdown_timeout` - `software_config.disable_terminal` - `labels`

type ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall added in v0.74.0 

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

func (*ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Context added in v0.74.0 

func (c *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Context(ctx context.Context) *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall

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

func (*ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Do added in v0.74.0 

func (c *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Do(opts ...googleapi.CallOption) (*RefreshRuntimeTokenInternalResponse, error)

Do executes the "notebooks.projects.locations.runtimes.refreshRuntimeTokenInternal" call. Any non-2xx status code is an error. Response headers are in either *RefreshRuntimeTokenInternalResponse.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 (*ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Fields added in v0.74.0 

func (c *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall

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

func (*ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall) Header added in v0.74.0 

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

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

type ProjectsLocationsRuntimesReportEventCall added in v0.51.0 

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

func (*ProjectsLocationsRuntimesReportEventCall) Context added in v0.51.0 

func (c *ProjectsLocationsRuntimesReportEventCall) Context(ctx context.Context) *ProjectsLocationsRuntimesReportEventCall

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

func (*ProjectsLocationsRuntimesReportEventCall) Do added in v0.51.0 

func (c *ProjectsLocationsRuntimesReportEventCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.reportEvent" 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 (*ProjectsLocationsRuntimesReportEventCall) Fields added in v0.51.0 

func (c *ProjectsLocationsRuntimesReportEventCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesReportEventCall

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

func (*ProjectsLocationsRuntimesReportEventCall) Header added in v0.51.0 

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

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

type ProjectsLocationsRuntimesResetCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesResetCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesResetCall) Context(ctx context.Context) *ProjectsLocationsRuntimesResetCall

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

func (*ProjectsLocationsRuntimesResetCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesResetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.reset" 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 (*ProjectsLocationsRuntimesResetCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesResetCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesResetCall

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

func (*ProjectsLocationsRuntimesResetCall) Header added in v0.44.0 

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

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

type ProjectsLocationsRuntimesService added in v0.44.0 

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

func NewProjectsLocationsRuntimesService added in v0.44.0 

func NewProjectsLocationsRuntimesService(s *Service) *ProjectsLocationsRuntimesService

func (*ProjectsLocationsRuntimesService) Create added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Create(parent string, runtime *Runtime) *ProjectsLocationsRuntimesCreateCall

Create: Creates a new Runtime in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsRuntimesService) Delete added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Delete(name string) *ProjectsLocationsRuntimesDeleteCall

Delete: Deletes a single Runtime.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) Diagnose added in v0.100.0 

func (r *ProjectsLocationsRuntimesService) Diagnose(name string, diagnoseruntimerequest *DiagnoseRuntimeRequest) *ProjectsLocationsRuntimesDiagnoseCall

Diagnose: Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`.

func (*ProjectsLocationsRuntimesService) Get added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Get(name string) *ProjectsLocationsRuntimesGetCall

Get: Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) GetIamPolicy added in v0.60.0 

func (r *ProjectsLocationsRuntimesService) GetIamPolicy(resource string) *ProjectsLocationsRuntimesGetIamPolicyCall

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 (*ProjectsLocationsRuntimesService) List added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) List(parent string) *ProjectsLocationsRuntimesListCall

List: Lists Runtimes in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsRuntimesService) Migrate added in v0.148.0 

func (r *ProjectsLocationsRuntimesService) Migrate(name string, migrateruntimerequest *MigrateRuntimeRequest) *ProjectsLocationsRuntimesMigrateCall

Migrate: Migrate an existing Runtime to a new Workbench Instance.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) Patch added in v0.81.0 

func (r *ProjectsLocationsRuntimesService) Patch(name string, runtime *Runtime) *ProjectsLocationsRuntimesPatchCall

Patch: Update Notebook Runtime configuration.

  • name: Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`.

func (*ProjectsLocationsRuntimesService) RefreshRuntimeTokenInternal added in v0.74.0 

func (r *ProjectsLocationsRuntimesService) RefreshRuntimeTokenInternal(name string, refreshruntimetokeninternalrequest *RefreshRuntimeTokenInternalRequest) *ProjectsLocationsRuntimesRefreshRuntimeTokenInternalCall

RefreshRuntimeTokenInternal: Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) ReportEvent added in v0.51.0 

func (r *ProjectsLocationsRuntimesService) ReportEvent(name string, reportruntimeeventrequest *ReportRuntimeEventRequest) *ProjectsLocationsRuntimesReportEventCall

ReportEvent: Reports and processes a runtime event.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) Reset added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Reset(name string, resetruntimerequest *ResetRuntimeRequest) *ProjectsLocationsRuntimesResetCall

Reset: Resets a Managed Notebook Runtime.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) SetIamPolicy added in v0.60.0 

func (r *ProjectsLocationsRuntimesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsRuntimesSetIamPolicyCall

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 (*ProjectsLocationsRuntimesService) Start added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Start(name string, startruntimerequest *StartRuntimeRequest) *ProjectsLocationsRuntimesStartCall

Start: Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) Stop added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Stop(name string, stopruntimerequest *StopRuntimeRequest) *ProjectsLocationsRuntimesStopCall

Stop: Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) Switch added in v0.44.0 

func (r *ProjectsLocationsRuntimesService) Switch(name string, switchruntimerequest *SwitchRuntimeRequest) *ProjectsLocationsRuntimesSwitchCall

Switch: Switch a Managed Notebook Runtime.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

func (*ProjectsLocationsRuntimesService) TestIamPermissions added in v0.60.0 

func (r *ProjectsLocationsRuntimesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsRuntimesTestIamPermissionsCall

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.

func (*ProjectsLocationsRuntimesService) Upgrade added in v0.100.0 

func (r *ProjectsLocationsRuntimesService) Upgrade(name string, upgraderuntimerequest *UpgradeRuntimeRequest) *ProjectsLocationsRuntimesUpgradeCall

Upgrade: Upgrades a Managed Notebook Runtime to the latest version.

  • name: Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`.

type ProjectsLocationsRuntimesSetIamPolicyCall added in v0.60.0 

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

func (*ProjectsLocationsRuntimesSetIamPolicyCall) Context added in v0.60.0 

func (c *ProjectsLocationsRuntimesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsRuntimesSetIamPolicyCall

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

func (*ProjectsLocationsRuntimesSetIamPolicyCall) Do added in v0.60.0 

func (c *ProjectsLocationsRuntimesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesSetIamPolicyCall) Fields added in v0.60.0 

func (c *ProjectsLocationsRuntimesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesSetIamPolicyCall

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

func (*ProjectsLocationsRuntimesSetIamPolicyCall) Header added in v0.60.0 

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

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

type ProjectsLocationsRuntimesStartCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesStartCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesStartCall) Context(ctx context.Context) *ProjectsLocationsRuntimesStartCall

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

func (*ProjectsLocationsRuntimesStartCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesStartCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesStartCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesStartCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesStartCall

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

func (*ProjectsLocationsRuntimesStartCall) Header added in v0.44.0 

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

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

type ProjectsLocationsRuntimesStopCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesStopCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesStopCall) Context(ctx context.Context) *ProjectsLocationsRuntimesStopCall

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

func (*ProjectsLocationsRuntimesStopCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesStopCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesStopCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesStopCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesStopCall

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

func (*ProjectsLocationsRuntimesStopCall) Header added in v0.44.0 

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

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

type ProjectsLocationsRuntimesSwitchCall added in v0.44.0 

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

func (*ProjectsLocationsRuntimesSwitchCall) Context added in v0.44.0 

func (c *ProjectsLocationsRuntimesSwitchCall) Context(ctx context.Context) *ProjectsLocationsRuntimesSwitchCall

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

func (*ProjectsLocationsRuntimesSwitchCall) Do added in v0.44.0 

func (c *ProjectsLocationsRuntimesSwitchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.switch" 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 (*ProjectsLocationsRuntimesSwitchCall) Fields added in v0.44.0 

func (c *ProjectsLocationsRuntimesSwitchCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesSwitchCall

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

func (*ProjectsLocationsRuntimesSwitchCall) Header added in v0.44.0 

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

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

type ProjectsLocationsRuntimesTestIamPermissionsCall added in v0.60.0 

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

func (*ProjectsLocationsRuntimesTestIamPermissionsCall) Context added in v0.60.0 

func (c *ProjectsLocationsRuntimesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsRuntimesTestIamPermissionsCall

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

func (*ProjectsLocationsRuntimesTestIamPermissionsCall) Do added in v0.60.0 

func (c *ProjectsLocationsRuntimesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "notebooks.projects.locations.runtimes.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 (*ProjectsLocationsRuntimesTestIamPermissionsCall) Fields added in v0.60.0 

func (c *ProjectsLocationsRuntimesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesTestIamPermissionsCall

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

func (*ProjectsLocationsRuntimesTestIamPermissionsCall) Header added in v0.60.0 

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

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

type ProjectsLocationsRuntimesUpgradeCall added in v0.100.0 

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

func (*ProjectsLocationsRuntimesUpgradeCall) Context added in v0.100.0 

func (c *ProjectsLocationsRuntimesUpgradeCall) Context(ctx context.Context) *ProjectsLocationsRuntimesUpgradeCall

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

func (*ProjectsLocationsRuntimesUpgradeCall) Do added in v0.100.0 

func (c *ProjectsLocationsRuntimesUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.runtimes.upgrade" 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 (*ProjectsLocationsRuntimesUpgradeCall) Fields added in v0.100.0 

func (c *ProjectsLocationsRuntimesUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsRuntimesUpgradeCall

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

func (*ProjectsLocationsRuntimesUpgradeCall) Header added in v0.100.0 

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

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

type ProjectsLocationsSchedulesCreateCall added in v0.38.0 

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

func (*ProjectsLocationsSchedulesCreateCall) Context added in v0.38.0 

func (c *ProjectsLocationsSchedulesCreateCall) Context(ctx context.Context) *ProjectsLocationsSchedulesCreateCall

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

func (*ProjectsLocationsSchedulesCreateCall) Do added in v0.38.0 

func (c *ProjectsLocationsSchedulesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.schedules.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 (*ProjectsLocationsSchedulesCreateCall) Fields added in v0.38.0 

func (c *ProjectsLocationsSchedulesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsSchedulesCreateCall

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

func (*ProjectsLocationsSchedulesCreateCall) Header added in v0.38.0 

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

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

func (*ProjectsLocationsSchedulesCreateCall) ScheduleId added in v0.38.0 

func (c *ProjectsLocationsSchedulesCreateCall) ScheduleId(scheduleId string) *ProjectsLocationsSchedulesCreateCall

ScheduleId sets the optional parameter "scheduleId": Required. User-defined unique ID of this schedule.

type ProjectsLocationsSchedulesDeleteCall added in v0.38.0 

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

func (*ProjectsLocationsSchedulesDeleteCall) Context added in v0.38.0 

func (c *ProjectsLocationsSchedulesDeleteCall) Context(ctx context.Context) *ProjectsLocationsSchedulesDeleteCall

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

func (*ProjectsLocationsSchedulesDeleteCall) Do added in v0.38.0 

func (c *ProjectsLocationsSchedulesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.schedules.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 (*ProjectsLocationsSchedulesDeleteCall) Fields added in v0.38.0 

func (c *ProjectsLocationsSchedulesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsSchedulesDeleteCall

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

func (*ProjectsLocationsSchedulesDeleteCall) Header added in v0.38.0 

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

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

type ProjectsLocationsSchedulesGetCall added in v0.38.0 

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

func (*ProjectsLocationsSchedulesGetCall) Context added in v0.38.0 

func (c *ProjectsLocationsSchedulesGetCall) Context(ctx context.Context) *ProjectsLocationsSchedulesGetCall

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

func (*ProjectsLocationsSchedulesGetCall) Do added in v0.38.0 

func (c *ProjectsLocationsSchedulesGetCall) Do(opts ...googleapi.CallOption) (*Schedule, error)

Do executes the "notebooks.projects.locations.schedules.get" call. Any non-2xx status code is an error. Response headers are in either *Schedule.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 (*ProjectsLocationsSchedulesGetCall) Fields added in v0.38.0 

func (c *ProjectsLocationsSchedulesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsSchedulesGetCall

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

func (*ProjectsLocationsSchedulesGetCall) Header added in v0.38.0 

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

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

func (*ProjectsLocationsSchedulesGetCall) IfNoneMatch added in v0.38.0 

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

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 ProjectsLocationsSchedulesListCall added in v0.38.0 

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

func (*ProjectsLocationsSchedulesListCall) Context added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) Context(ctx context.Context) *ProjectsLocationsSchedulesListCall

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

func (*ProjectsLocationsSchedulesListCall) Do added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) Do(opts ...googleapi.CallOption) (*ListSchedulesResponse, error)

Do executes the "notebooks.projects.locations.schedules.list" call. Any non-2xx status code is an error. Response headers are in either *ListSchedulesResponse.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 (*ProjectsLocationsSchedulesListCall) Fields added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsSchedulesListCall

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

func (*ProjectsLocationsSchedulesListCall) Filter added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) Filter(filter string) *ProjectsLocationsSchedulesListCall

Filter sets the optional parameter "filter": Filter applied to resulting schedules.

func (*ProjectsLocationsSchedulesListCall) Header added in v0.38.0 

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

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

func (*ProjectsLocationsSchedulesListCall) IfNoneMatch added in v0.38.0 

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

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 (*ProjectsLocationsSchedulesListCall) OrderBy added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) OrderBy(orderBy string) *ProjectsLocationsSchedulesListCall

OrderBy sets the optional parameter "orderBy": Field to order results by.

func (*ProjectsLocationsSchedulesListCall) PageSize added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) PageSize(pageSize int64) *ProjectsLocationsSchedulesListCall

PageSize sets the optional parameter "pageSize": Maximum return size of the list call.

func (*ProjectsLocationsSchedulesListCall) PageToken added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) PageToken(pageToken string) *ProjectsLocationsSchedulesListCall

PageToken sets the optional parameter "pageToken": A previous returned page token that can be used to continue listing from the last result.

func (*ProjectsLocationsSchedulesListCall) Pages added in v0.38.0 

func (c *ProjectsLocationsSchedulesListCall) Pages(ctx context.Context, f func(*ListSchedulesResponse) error) error

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 ProjectsLocationsSchedulesService added in v0.38.0 

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

func NewProjectsLocationsSchedulesService added in v0.38.0 

func NewProjectsLocationsSchedulesService(s *Service) *ProjectsLocationsSchedulesService

func (*ProjectsLocationsSchedulesService) Create added in v0.38.0 

func (r *ProjectsLocationsSchedulesService) Create(parent string, schedule *Schedule) *ProjectsLocationsSchedulesCreateCall

Create: Creates a new Scheduled Notebook in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsSchedulesService) Delete added in v0.38.0 

func (r *ProjectsLocationsSchedulesService) Delete(name string) *ProjectsLocationsSchedulesDeleteCall

Delete: Deletes schedule and all underlying jobs

  • name: Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`.

func (*ProjectsLocationsSchedulesService) Get added in v0.38.0 

func (r *ProjectsLocationsSchedulesService) Get(name string) *ProjectsLocationsSchedulesGetCall

Get: Gets details of schedule

  • name: Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`.

func (*ProjectsLocationsSchedulesService) List added in v0.38.0 

func (r *ProjectsLocationsSchedulesService) List(parent string) *ProjectsLocationsSchedulesListCall

List: Lists schedules in a given project and location.

- parent: Format: `parent=projects/{project_id}/locations/{location}`.

func (*ProjectsLocationsSchedulesService) Trigger added in v0.38.0 

func (r *ProjectsLocationsSchedulesService) Trigger(name string, triggerschedulerequest *TriggerScheduleRequest) *ProjectsLocationsSchedulesTriggerCall

Trigger: Triggers execution of an existing schedule.

  • name: Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`.

type ProjectsLocationsSchedulesTriggerCall added in v0.38.0 

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

func (*ProjectsLocationsSchedulesTriggerCall) Context added in v0.38.0 

func (c *ProjectsLocationsSchedulesTriggerCall) Context(ctx context.Context) *ProjectsLocationsSchedulesTriggerCall

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

func (*ProjectsLocationsSchedulesTriggerCall) Do added in v0.38.0 

func (c *ProjectsLocationsSchedulesTriggerCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "notebooks.projects.locations.schedules.trigger" 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 (*ProjectsLocationsSchedulesTriggerCall) Fields added in v0.38.0 

func (c *ProjectsLocationsSchedulesTriggerCall) Fields(s ...googleapi.Field) *ProjectsLocationsSchedulesTriggerCall

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

func (*ProjectsLocationsSchedulesTriggerCall) Header added in v0.38.0 

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

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

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Environments *ProjectsLocationsEnvironmentsService

	Executions *ProjectsLocationsExecutionsService

	Instances *ProjectsLocationsInstancesService

	Operations *ProjectsLocationsOperationsService

	Runtimes *ProjectsLocationsRuntimesService

	Schedules *ProjectsLocationsSchedulesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get 

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List 

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

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

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

type ProjectsService 

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

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type RefreshRuntimeTokenInternalRequest added in v0.74.0 

type RefreshRuntimeTokenInternalRequest struct {
	// VmId: Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `json:"vmId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "VmId") 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. "VmId") 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:"-"`
}

RefreshRuntimeTokenInternalRequest: Request for getting a new access token.

func (RefreshRuntimeTokenInternalRequest) MarshalJSON added in v0.74.0 

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

type RefreshRuntimeTokenInternalResponse added in v0.74.0 

type RefreshRuntimeTokenInternalResponse struct {
	// AccessToken: The OAuth 2.0 access token.
	AccessToken string `json:"accessToken,omitempty"`
	// ExpireTime: Output only. Token expiration time.
	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:"-"`
}

RefreshRuntimeTokenInternalResponse: Response with a new access token.

func (RefreshRuntimeTokenInternalResponse) MarshalJSON added in v0.74.0 

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

type RegisterInstanceRequest 

type RegisterInstanceRequest struct {
	// InstanceId: Required. User defined unique ID of this instance. The
	// `instance_id` must be 1 to 63 characters long and contain only lowercase
	// letters, numeric characters, and dashes. The first character must be a
	// lowercase letter and the last character cannot be a dash.
	InstanceId string `json:"instanceId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InstanceId") 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. "InstanceId") 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:"-"`
}

RegisterInstanceRequest: Request for registering a notebook instance.

func (RegisterInstanceRequest) MarshalJSON 

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

type ReportInstanceEventRequest added in v0.109.0 

type ReportInstanceEventRequest struct {
	// Event: Required. The Event to be reported.
	Event *Event `json:"event,omitempty"`
	// VmId: Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `json:"vmId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Event") 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. "Event") 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:"-"`
}

ReportInstanceEventRequest: Request for reporting a Managed Notebook Event.

func (ReportInstanceEventRequest) MarshalJSON added in v0.109.0 

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

type ReportInstanceInfoRequest 

type ReportInstanceInfoRequest struct {
	// Metadata: The metadata reported to Notebooks API. This will be merged to the
	// instance metadata store
	Metadata map[string]string `json:"metadata,omitempty"`
	// VmId: Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `json:"vmId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Metadata") 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. "Metadata") 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:"-"`
}

ReportInstanceInfoRequest: Request for notebook instances to report information to Notebooks API.

func (ReportInstanceInfoRequest) MarshalJSON 

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

type ReportRuntimeEventRequest added in v0.51.0 

type ReportRuntimeEventRequest struct {
	// Event: Required. The Event to be reported.
	Event *Event `json:"event,omitempty"`
	// VmId: Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `json:"vmId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Event") 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. "Event") 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:"-"`
}

ReportRuntimeEventRequest: Request for reporting a Managed Notebook Event.

func (ReportRuntimeEventRequest) MarshalJSON added in v0.51.0 

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

type ReservationAffinity added in v0.51.0 

type ReservationAffinity struct {
	// ConsumeReservationType: Optional. Type of reservation to consume
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Default type.
	//   "NO_RESERVATION" - Do not consume from any allocated capacity.
	//   "ANY_RESERVATION" - Consume any reservation available.
	//   "SPECIFIC_RESERVATION" - Must consume from a specific reservation. Must
	// specify key value fields for specifying the reservations.
	ConsumeReservationType string `json:"consumeReservationType,omitempty"`
	// Key: Optional. Corresponds to the label key of reservation resource.
	Key string `json:"key,omitempty"`
	// Values: Optional. Corresponds to the label values of reservation resource.
	Values []string `json:"values,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsumeReservationType") 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. "ConsumeReservationType") 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:"-"`
}

ReservationAffinity: Reservation Affinity for consuming Zonal reservation.

func (ReservationAffinity) MarshalJSON added in v0.51.0 

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

type ResetInstanceRequest 

type ResetInstanceRequest struct {
}

ResetInstanceRequest: Request for resetting a notebook instance

type ResetRuntimeRequest added in v0.44.0 

type ResetRuntimeRequest struct {
	// RequestId: Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

ResetRuntimeRequest: Request for resetting a Managed Notebook Runtime.

func (ResetRuntimeRequest) MarshalJSON added in v0.73.0 

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

type RollbackInstanceRequest added in v0.45.0 

type RollbackInstanceRequest struct {
	// TargetSnapshot: Required. The snapshot for rollback. Example:
	// `projects/test-project/global/snapshots/krwlzipynril`.
	TargetSnapshot string `json:"targetSnapshot,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TargetSnapshot") 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. "TargetSnapshot") 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:"-"`
}

RollbackInstanceRequest: Request for rollbacking a notebook instance

func (RollbackInstanceRequest) MarshalJSON added in v0.45.0 

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

type Runtime added in v0.44.0 

type Runtime struct {
	// AccessConfig: The config settings for accessing runtime.
	AccessConfig *RuntimeAccessConfig `json:"accessConfig,omitempty"`
	// CreateTime: Output only. Runtime creation time.
	CreateTime string `json:"createTime,omitempty"`
	// HealthState: Output only. Runtime health_state.
	//
	// Possible values:
	//   "HEALTH_STATE_UNSPECIFIED" - The runtime substate is unknown.
	//   "HEALTHY" - The runtime is known to be in an healthy state (for example,
	// critical daemons are running) Applies to ACTIVE state.
	//   "UNHEALTHY" - The runtime is known to be in an unhealthy state (for
	// example, critical daemons are not running) Applies to ACTIVE state.
	//   "AGENT_NOT_INSTALLED" - The runtime has not installed health monitoring
	// agent. Applies to ACTIVE state.
	//   "AGENT_NOT_RUNNING" - The runtime health monitoring agent is not running.
	// Applies to ACTIVE state.
	HealthState string `json:"healthState,omitempty"`
	// Labels: Optional. The labels to associate with this Managed Notebook or
	// Runtime. Label **keys** must contain 1 to 63 characters, and must conform to
	// RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be
	// empty, but, if present, must contain 1 to 63 characters, and must conform to
	// RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can
	// be associated with a cluster.
	Labels map[string]string `json:"labels,omitempty"`
	// Metrics: Output only. Contains Runtime daemon metrics such as Service status
	// and JupyterLab stats.
	Metrics *RuntimeMetrics `json:"metrics,omitempty"`
	// Migrated: Output only. Bool indicating whether this notebook has been
	// migrated to a Workbench Instance
	Migrated bool `json:"migrated,omitempty"`
	// Name: Output only. The resource name of the runtime. Format:
	// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
	Name string `json:"name,omitempty"`
	// RuntimeMigrationEligibility: Output only. Checks how feasible a migration
	// from GmN to WbI is.
	RuntimeMigrationEligibility *RuntimeMigrationEligibility `json:"runtimeMigrationEligibility,omitempty"`
	// SoftwareConfig: The config settings for software inside the runtime.
	SoftwareConfig *RuntimeSoftwareConfig `json:"softwareConfig,omitempty"`
	// State: Output only. Runtime state.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - State is not specified.
	//   "STARTING" - The compute layer is starting the runtime. It is not ready
	// for use.
	//   "PROVISIONING" - The compute layer is installing required frameworks and
	// registering the runtime with notebook proxy. It cannot be used.
	//   "ACTIVE" - The runtime is currently running. It is ready for use.
	//   "STOPPING" - The control logic is stopping the runtime. It cannot be used.
	//   "STOPPED" - The runtime is stopped. It cannot be used.
	//   "DELETING" - The runtime is being deleted. It cannot be used.
	//   "UPGRADING" - The runtime is upgrading. It cannot be used.
	//   "INITIALIZING" - The runtime is being created and set up. It is not ready
	// for use.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. Runtime update time.
	UpdateTime string `json:"updateTime,omitempty"`
	// VirtualMachine: Use a Compute Engine VM image to start the managed notebook
	// instance.
	VirtualMachine *VirtualMachine `json:"virtualMachine,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AccessConfig") 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. "AccessConfig") 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:"-"`
}

Runtime: The definition of a Runtime for a managed notebook instance.

func (Runtime) MarshalJSON added in v0.44.0 

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

type RuntimeAcceleratorConfig added in v0.44.0 

type RuntimeAcceleratorConfig struct {
	// CoreCount: Count of cores of this accelerator.
	CoreCount int64 `json:"coreCount,omitempty,string"`
	// Type: Accelerator model.
	//
	// Possible values:
	//   "ACCELERATOR_TYPE_UNSPECIFIED" - Accelerator type is not specified.
	//   "NVIDIA_TESLA_K80" - Accelerator type is Nvidia Tesla K80.
	//   "NVIDIA_TESLA_P100" - Accelerator type is Nvidia Tesla P100.
	//   "NVIDIA_TESLA_V100" - Accelerator type is Nvidia Tesla V100.
	//   "NVIDIA_TESLA_P4" - Accelerator type is Nvidia Tesla P4.
	//   "NVIDIA_TESLA_T4" - Accelerator type is Nvidia Tesla T4.
	//   "NVIDIA_TESLA_A100" - Accelerator type is Nvidia Tesla A100 - 40GB.
	//   "NVIDIA_L4" - Accelerator type is Nvidia L4.
	//   "TPU_V2" - (Coming soon) Accelerator type is TPU V2.
	//   "TPU_V3" - (Coming soon) Accelerator type is TPU V3.
	//   "NVIDIA_TESLA_T4_VWS" - Accelerator type is NVIDIA Tesla T4 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P100_VWS" - Accelerator type is NVIDIA Tesla P100 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P4_VWS" - Accelerator type is NVIDIA Tesla P4 Virtual
	// Workstations.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CoreCount") 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. "CoreCount") 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:"-"`
}

RuntimeAcceleratorConfig: Definition of the types of hardware accelerators that can be used. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: * `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100`

func (RuntimeAcceleratorConfig) MarshalJSON added in v0.44.0 

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

type RuntimeAccessConfig added in v0.44.0 

type RuntimeAccessConfig struct {
	// AccessType: The type of access mode this instance.
	//
	// Possible values:
	//   "RUNTIME_ACCESS_TYPE_UNSPECIFIED" - Unspecified access.
	//   "SINGLE_USER" - Single user login.
	//   "SERVICE_ACCOUNT" - Service Account mode. In Service Account mode, Runtime
	// creator will specify a SA that exists in the consumer project. Using Runtime
	// Service Account field. Users accessing the Runtime need ActAs (Service
	// Account User) permission.
	AccessType string `json:"accessType,omitempty"`
	// ProxyUri: Output only. The proxy endpoint that is used to access the
	// runtime.
	ProxyUri string `json:"proxyUri,omitempty"`
	// RuntimeOwner: The owner of this runtime after creation. Format:
	// `alias@example.com` Currently supports one owner only.
	RuntimeOwner string `json:"runtimeOwner,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessType") 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. "AccessType") 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:"-"`
}

RuntimeAccessConfig: Specifies the login configuration for Runtime

func (RuntimeAccessConfig) MarshalJSON added in v0.44.0 

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

type RuntimeGuestOsFeature added in v0.44.0 

type RuntimeGuestOsFeature struct {
	// Type: The ID of a supported feature. Read Enabling guest operating system
	// features
	// (https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
	// to see a list of available options. Valid values: *
	// `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` *
	// `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") 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. "Type") 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:"-"`
}

RuntimeGuestOsFeature: Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features (https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

func (RuntimeGuestOsFeature) MarshalJSON added in v0.44.0 

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

type RuntimeMetrics added in v0.44.0 

type RuntimeMetrics struct {
	// SystemMetrics: Output only. The system metrics.
	SystemMetrics map[string]string `json:"systemMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SystemMetrics") 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. "SystemMetrics") 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:"-"`
}

RuntimeMetrics: Contains runtime daemon metrics, such as OS and kernels and sessions stats.

func (RuntimeMetrics) MarshalJSON added in v0.44.0 

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

type RuntimeMigrationEligibility added in v0.142.0 

type RuntimeMigrationEligibility struct {
	// Errors: Output only. Certain configurations make the GmN ineligible for an
	// automatic migration. A manual migration is required.
	//
	// Possible values:
	//   "ERROR_UNSPECIFIED" - Default type.
	//   "CUSTOM_CONTAINER" - The GmN is configured with custom container(s) and
	// cannot be migrated.
	Errors []string `json:"errors,omitempty"`
	// Warnings: Output only. Certain configurations will be defaulted during the
	// migration.
	//
	// Possible values:
	//   "WARNING_UNSPECIFIED" - Default type.
	//   "UNSUPPORTED_ACCELERATOR_TYPE" - The GmN uses an accelerator type that's
	// unsupported in WbI. It will be migrated without an accelerator. Users can
	// attach an accelerator after the migration.
	//   "UNSUPPORTED_OS" - The GmN uses an operating system that's unsupported in
	// WbI (e.g. Debian 10). It will be replaced with Debian 11 in WbI.
	//   "RESERVED_IP_RANGE" - This GmN is configured with reserved IP range, which
	// is no longer applicable in WbI.
	//   "GOOGLE_MANAGED_NETWORK" - This GmN is configured with a Google managed
	// network. Please provide the `network` and `subnet` options for the
	// migration.
	//   "POST_STARTUP_SCRIPT" - This GmN is configured with a post startup script.
	// Please optionally provide the `post_startup_script_option` for the
	// migration.
	//   "SINGLE_USER" - This GmN is configured with single user mode. Please
	// optionally provide the `service_account` option for the migration.
	Warnings []string `json:"warnings,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Errors") 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. "Errors") 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:"-"`
}

RuntimeMigrationEligibility: RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.

func (RuntimeMigrationEligibility) MarshalJSON added in v0.142.0 

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

type RuntimeShieldedInstanceConfig added in v0.44.0 

type RuntimeShieldedInstanceConfig struct {
	// EnableIntegrityMonitoring: Defines whether the instance has integrity
	// monitoring enabled. Enables monitoring and attestation of the boot integrity
	// of the instance. The attestation is performed against the integrity policy
	// baseline. This baseline is initially derived from the implicitly trusted
	// boot image when the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool `json:"enableIntegrityMonitoring,omitempty"`
	// EnableSecureBoot: Defines whether the instance has Secure Boot enabled.
	// Secure Boot helps ensure that the system only runs authentic software by
	// verifying the digital signature of all boot components, and halting the boot
	// process if signature verification fails. Disabled by default.
	EnableSecureBoot bool `json:"enableSecureBoot,omitempty"`
	// EnableVtpm: Defines whether the instance has the vTPM enabled. Enabled by
	// default.
	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:"-"`
}

RuntimeShieldedInstanceConfig: A set of Shielded Instance options. See Images using supported Shielded VM features (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

func (RuntimeShieldedInstanceConfig) MarshalJSON added in v0.44.0 

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

type RuntimeSoftwareConfig added in v0.44.0 

type RuntimeSoftwareConfig struct {
	// CustomGpuDriverPath: Specify a custom Cloud Storage path where the GPU
	// driver is stored. If not specified, we'll automatically choose from official
	// GPU drivers.
	CustomGpuDriverPath string `json:"customGpuDriverPath,omitempty"`
	// DisableTerminal: Bool indicating whether JupyterLab terminal will be
	// available or not. Default: False
	DisableTerminal bool `json:"disableTerminal,omitempty"`
	// EnableHealthMonitoring: Verifies core internal services are running.
	// Default: True
	EnableHealthMonitoring bool `json:"enableHealthMonitoring,omitempty"`
	// IdleShutdown: Runtime will automatically shutdown after idle_shutdown_time.
	// Default: True
	IdleShutdown bool `json:"idleShutdown,omitempty"`
	// IdleShutdownTimeout: Time in minutes to wait before shutting down runtime.
	// Default: 180 minutes
	IdleShutdownTimeout int64 `json:"idleShutdownTimeout,omitempty"`
	// InstallGpuDriver: Install Nvidia Driver automatically. Default: True
	InstallGpuDriver bool `json:"installGpuDriver,omitempty"`
	// Kernels: Optional. Use a list of container images to use as Kernels in the
	// notebook instance.
	Kernels []*ContainerImage `json:"kernels,omitempty"`
	// MixerDisabled: Bool indicating whether mixer client should be disabled.
	// Default: False
	MixerDisabled bool `json:"mixerDisabled,omitempty"`
	// NotebookUpgradeSchedule: Cron expression in UTC timezone, used to schedule
	// instance auto upgrade. Please follow the cron format
	// (https://en.wikipedia.org/wiki/Cron).
	NotebookUpgradeSchedule string `json:"notebookUpgradeSchedule,omitempty"`
	// PostStartupScript: Path to a Bash script that automatically runs after a
	// notebook instance fully boots up. The path must be a URL or Cloud Storage
	// path (`gs://path-to-file/file-name`).
	PostStartupScript string `json:"postStartupScript,omitempty"`
	// PostStartupScriptBehavior: Behavior for the post startup script.
	//
	// Possible values:
	//   "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED" - Unspecified post startup
	// script behavior. Will run only once at creation.
	//   "RUN_EVERY_START" - Runs the post startup script provided during creation
	// at every start.
	//   "DOWNLOAD_AND_RUN_EVERY_START" - Downloads and runs the provided post
	// startup script at every start.
	PostStartupScriptBehavior string `json:"postStartupScriptBehavior,omitempty"`
	// Upgradeable: Output only. Bool indicating whether an newer image is
	// available in an image family.
	Upgradeable bool `json:"upgradeable,omitempty"`
	// Version: Output only. version of boot image such as M100, from release label
	// of the image.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomGpuDriverPath") 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. "CustomGpuDriverPath") 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:"-"`
}

RuntimeSoftwareConfig: Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `enable_health_monitoring: true`

func (RuntimeSoftwareConfig) MarshalJSON added in v0.44.0 

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

type Schedule added in v0.38.0 

type Schedule struct {
	// CreateTime: Output only. Time the schedule was created.
	CreateTime string `json:"createTime,omitempty"`
	// CronSchedule: Cron-tab formatted schedule by which the job will execute.
	// Format: minute, hour, day of month, month, day of week, e.g. `0 0 * * WED` =
	// every Wednesday More examples: https://crontab.guru/examples.html
	CronSchedule string `json:"cronSchedule,omitempty"`
	// Description: A brief description of this environment.
	Description string `json:"description,omitempty"`
	// DisplayName: Output only. Display name used for UI purposes. Name can only
	// contain alphanumeric characters, hyphens `-`, and underscores `_`.
	DisplayName string `json:"displayName,omitempty"`
	// ExecutionTemplate: Notebook Execution Template corresponding to this
	// schedule.
	ExecutionTemplate *ExecutionTemplate `json:"executionTemplate,omitempty"`
	// Name: Output only. The name of this schedule. Format:
	// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
	Name string `json:"name,omitempty"`
	// RecentExecutions: Output only. The most recent execution names triggered
	// from this schedule and their corresponding states.
	RecentExecutions []*Execution `json:"recentExecutions,omitempty"`
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "ENABLED" - The job is executing normally.
	//   "PAUSED" - The job is paused by the user. It will not execute. A user can
	// intentionally pause the job using [Cloud
	// Scheduler](https://cloud.google.com/scheduler/docs/creating#pause).
	//   "DISABLED" - The job is disabled by the system due to error. The user
	// cannot directly set a job to be disabled.
	//   "UPDATE_FAILED" - The job state resulting from a failed
	// [CloudScheduler.UpdateJob](https://cloud.google.com/scheduler/docs/creating#e
	// dit) operation. To recover a job from this state, retry
	// [CloudScheduler.UpdateJob](https://cloud.google.com/scheduler/docs/creating#e
	// dit) until a successful response is received.
	//   "INITIALIZING" - The schedule resource is being created.
	//   "DELETING" - The schedule resource is being deleted.
	State string `json:"state,omitempty"`
	// TimeZone: Timezone on which the cron_schedule. The value of this field must
	// be a time zone name from the tz database. TZ Database:
	// https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some
	// time zones include a provision for daylight savings time. The rules for
	// daylight saving time are determined by the chosen tz. For UTC use the string
	// "utc". If a time zone is not specified, the default will be in UTC (also
	// known as GMT).
	TimeZone string `json:"timeZone,omitempty"`
	// UpdateTime: Output only. Time the schedule was last 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. "CreateTime") 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. "CreateTime") 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:"-"`
}

Schedule: The definition of a schedule.

func (Schedule) MarshalJSON added in v0.38.0 

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

type SchedulerAcceleratorConfig added in v0.38.0 

type SchedulerAcceleratorConfig struct {
	// CoreCount: Count of cores of this accelerator.
	CoreCount int64 `json:"coreCount,omitempty,string"`
	// Type: Type of this accelerator.
	//
	// Possible values:
	//   "SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED" - Unspecified accelerator type.
	// Default to no GPU.
	//   "NVIDIA_TESLA_K80" - Nvidia Tesla K80 GPU.
	//   "NVIDIA_TESLA_P100" - Nvidia Tesla P100 GPU.
	//   "NVIDIA_TESLA_V100" - Nvidia Tesla V100 GPU.
	//   "NVIDIA_TESLA_P4" - Nvidia Tesla P4 GPU.
	//   "NVIDIA_TESLA_T4" - Nvidia Tesla T4 GPU.
	//   "NVIDIA_TESLA_A100" - Nvidia Tesla A100 GPU.
	//   "TPU_V2" - TPU v2.
	//   "TPU_V3" - TPU v3.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CoreCount") 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. "CoreCount") 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:"-"`
}

SchedulerAcceleratorConfig: Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported.

func (SchedulerAcceleratorConfig) MarshalJSON added in v0.38.0 

func (s SchedulerAcceleratorConfig) 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"`
	// 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 SetInstanceAcceleratorRequest 

type SetInstanceAcceleratorRequest struct {
	// CoreCount: Required. Count of cores of this accelerator. Note that not all
	// combinations of `type` and `core_count` are valid. See GPUs on Compute
	// Engine (https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
	// valid combination. TPUs are not supported.
	CoreCount int64 `json:"coreCount,omitempty,string"`
	// Type: Required. Type of this accelerator.
	//
	// Possible values:
	//   "ACCELERATOR_TYPE_UNSPECIFIED" - Accelerator type is not specified.
	//   "NVIDIA_TESLA_K80" - Accelerator type is Nvidia Tesla K80.
	//   "NVIDIA_TESLA_P100" - Accelerator type is Nvidia Tesla P100.
	//   "NVIDIA_TESLA_V100" - Accelerator type is Nvidia Tesla V100.
	//   "NVIDIA_TESLA_P4" - Accelerator type is Nvidia Tesla P4.
	//   "NVIDIA_TESLA_T4" - Accelerator type is Nvidia Tesla T4.
	//   "NVIDIA_TESLA_A100" - Accelerator type is Nvidia Tesla A100.
	//   "NVIDIA_L4" - Accelerator type is Nvidia Tesla L4.
	//   "NVIDIA_A100_80GB" - Accelerator type is Nvidia Tesla A100 80GB.
	//   "NVIDIA_TESLA_T4_VWS" - Accelerator type is NVIDIA Tesla T4 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P100_VWS" - Accelerator type is NVIDIA Tesla P100 Virtual
	// Workstations.
	//   "NVIDIA_TESLA_P4_VWS" - Accelerator type is NVIDIA Tesla P4 Virtual
	// Workstations.
	//   "NVIDIA_H100_80GB" - Accelerator type is NVIDIA H100 80GB.
	//   "NVIDIA_H100_MEGA_80GB" - Accelerator type is NVIDIA H100 Mega 80GB.
	//   "TPU_V2" - (Coming soon) Accelerator type is TPU V2.
	//   "TPU_V3" - (Coming soon) Accelerator type is TPU V3.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CoreCount") 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. "CoreCount") 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:"-"`
}

SetInstanceAcceleratorRequest: Request for setting instance accelerator.

func (SetInstanceAcceleratorRequest) MarshalJSON 

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

type SetInstanceLabelsRequest 

type SetInstanceLabelsRequest struct {
	// Labels: Labels to apply to this instance. These can be later modified by the
	// setLabels method
	Labels map[string]string `json:"labels,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Labels") 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. "Labels") 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:"-"`
}

SetInstanceLabelsRequest: Request for setting instance labels.

func (SetInstanceLabelsRequest) MarshalJSON 

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

type SetInstanceMachineTypeRequest 

type SetInstanceMachineTypeRequest struct {
	// MachineType: Required. The Compute Engine machine type
	// (https://cloud.google.com/compute/docs/machine-resource).
	MachineType string `json:"machineType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MachineType") 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. "MachineType") 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:"-"`
}

SetInstanceMachineTypeRequest: Request for setting instance machine type.

func (SetInstanceMachineTypeRequest) MarshalJSON 

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

type ShieldedInstanceConfig added in v0.37.0 

type ShieldedInstanceConfig struct {
	// EnableIntegrityMonitoring: Defines whether the instance has integrity
	// monitoring enabled. Enables monitoring and attestation of the boot integrity
	// of the instance. The attestation is performed against the integrity policy
	// baseline. This baseline is initially derived from the implicitly trusted
	// boot image when the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool `json:"enableIntegrityMonitoring,omitempty"`
	// EnableSecureBoot: Defines whether the instance has Secure Boot enabled.
	// Secure Boot helps ensure that the system only runs authentic software by
	// verifying the digital signature of all boot components, and halting the boot
	// process if signature verification fails. Disabled by default.
	EnableSecureBoot bool `json:"enableSecureBoot,omitempty"`
	// EnableVtpm: Defines whether the instance has the vTPM enabled. Enabled by
	// default.
	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:"-"`
}

ShieldedInstanceConfig: A set of Shielded Instance options. See Images using supported Shielded VM features (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

func (ShieldedInstanceConfig) MarshalJSON added in v0.37.0 

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

type StartInstanceRequest 

type StartInstanceRequest struct {
}

StartInstanceRequest: Request for starting a notebook instance

type StartRuntimeRequest added in v0.44.0 

type StartRuntimeRequest struct {
	// RequestId: Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

StartRuntimeRequest: Request for starting a Managed Notebook Runtime.

func (StartRuntimeRequest) MarshalJSON added in v0.73.0 

func (s StartRuntimeRequest) 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 StopInstanceRequest 

type StopInstanceRequest struct {
}

StopInstanceRequest: Request for stopping a notebook instance

type StopRuntimeRequest added in v0.44.0 

type StopRuntimeRequest struct {
	// RequestId: Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

StopRuntimeRequest: Request for stopping a Managed Notebook Runtime.

func (StopRuntimeRequest) MarshalJSON added in v0.73.0 

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

type SwitchRuntimeRequest added in v0.44.0 

type SwitchRuntimeRequest struct {
	// AcceleratorConfig: accelerator config.
	AcceleratorConfig *RuntimeAcceleratorConfig `json:"acceleratorConfig,omitempty"`
	// MachineType: machine type.
	MachineType string `json:"machineType,omitempty"`
	// RequestId: Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AcceleratorConfig") 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. "AcceleratorConfig") 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:"-"`
}

SwitchRuntimeRequest: Request for switching a Managed Notebook Runtime.

func (SwitchRuntimeRequest) MarshalJSON added in v0.44.0 

func (s SwitchRuntimeRequest) 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 TriggerScheduleRequest added in v0.38.0 

type TriggerScheduleRequest struct {
}

TriggerScheduleRequest: Request for created scheduled notebooks

type UpdateInstanceConfigRequest added in v0.49.0 

type UpdateInstanceConfigRequest struct {
	// Config: The instance configurations to be updated.
	Config *InstanceConfig `json:"config,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") 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. "Config") 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:"-"`
}

UpdateInstanceConfigRequest: Request for updating instance configurations.

func (UpdateInstanceConfigRequest) MarshalJSON added in v0.49.0 

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

type UpdateInstanceMetadataItemsRequest added in v0.65.0 

type UpdateInstanceMetadataItemsRequest struct {
	// Items: Metadata items to add/update for the instance.
	Items map[string]string `json:"items,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`
}

UpdateInstanceMetadataItemsRequest: Request for adding/changing metadata items for an instance.

func (UpdateInstanceMetadataItemsRequest) MarshalJSON added in v0.65.0 

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

type UpdateInstanceMetadataItemsResponse added in v0.65.0 

type UpdateInstanceMetadataItemsResponse struct {
	// Items: Map of items that were added/updated to/in the metadata.
	Items map[string]string `json:"items,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`
}

UpdateInstanceMetadataItemsResponse: Response for adding/changing metadata items for an instance.

func (UpdateInstanceMetadataItemsResponse) MarshalJSON added in v0.65.0 

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

type UpdateShieldedInstanceConfigRequest added in v0.44.0 

type UpdateShieldedInstanceConfigRequest struct {
	// ShieldedInstanceConfig: ShieldedInstance configuration to be updated.
	ShieldedInstanceConfig *ShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ShieldedInstanceConfig") 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. "ShieldedInstanceConfig") 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:"-"`
}

UpdateShieldedInstanceConfigRequest: Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance

func (UpdateShieldedInstanceConfigRequest) MarshalJSON added in v0.44.0 

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

type UpgradeHistoryEntry 

type UpgradeHistoryEntry struct {
	// Action: Action. Rolloback or Upgrade.
	//
	// Possible values:
	//   "ACTION_UNSPECIFIED" - Operation is not specified.
	//   "UPGRADE" - Upgrade.
	//   "ROLLBACK" - Rollback.
	Action string `json:"action,omitempty"`
	// ContainerImage: The container image before this instance upgrade.
	ContainerImage string `json:"containerImage,omitempty"`
	// CreateTime: The time that this instance upgrade history entry is created.
	CreateTime string `json:"createTime,omitempty"`
	// Framework: The framework of this notebook instance.
	Framework string `json:"framework,omitempty"`
	// Snapshot: The snapshot of the boot disk of this notebook instance before
	// upgrade.
	Snapshot string `json:"snapshot,omitempty"`
	// State: The state of this instance upgrade history entry.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - State is not specified.
	//   "STARTED" - The instance upgrade is started.
	//   "SUCCEEDED" - The instance upgrade is succeeded.
	//   "FAILED" - The instance upgrade is failed.
	State string `json:"state,omitempty"`
	// TargetImage: Target VM Image. Format:
	// `ainotebooks-vm/project/image-name/name`.
	TargetImage string `json:"targetImage,omitempty"`
	// TargetVersion: Target VM Version, like m63.
	TargetVersion string `json:"targetVersion,omitempty"`
	// Version: The version of the notebook instance before this upgrade.
	Version string `json:"version,omitempty"`
	// VmImage: The VM image before this instance upgrade.
	VmImage string `json:"vmImage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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:"-"`
}

UpgradeHistoryEntry: The entry of VM image upgrade history.

func (UpgradeHistoryEntry) MarshalJSON 

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

type UpgradeInstanceInternalRequest 

type UpgradeInstanceInternalRequest struct {
	// Type: Optional. The optional UpgradeType. Setting this field will search for
	// additional compute images to upgrade this instance.
	//
	// Possible values:
	//   "UPGRADE_TYPE_UNSPECIFIED" - Upgrade type is not specified.
	//   "UPGRADE_FRAMEWORK" - Upgrade ML framework.
	//   "UPGRADE_OS" - Upgrade Operating System.
	//   "UPGRADE_CUDA" - Upgrade CUDA.
	//   "UPGRADE_ALL" - Upgrade All (OS, Framework and CUDA).
	Type string `json:"type,omitempty"`
	// VmId: Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `json:"vmId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") 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. "Type") 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:"-"`
}

UpgradeInstanceInternalRequest: Request for upgrading a notebook instance from within the VM

func (UpgradeInstanceInternalRequest) MarshalJSON 

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

type UpgradeInstanceRequest 

type UpgradeInstanceRequest struct {
	// Type: Optional. The optional UpgradeType. Setting this field will search for
	// additional compute images to upgrade this instance.
	//
	// Possible values:
	//   "UPGRADE_TYPE_UNSPECIFIED" - Upgrade type is not specified.
	//   "UPGRADE_FRAMEWORK" - Upgrade ML framework.
	//   "UPGRADE_OS" - Upgrade Operating System.
	//   "UPGRADE_CUDA" - Upgrade CUDA.
	//   "UPGRADE_ALL" - Upgrade All (OS, Framework and CUDA).
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") 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. "Type") 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:"-"`
}

UpgradeInstanceRequest: Request for upgrading a notebook instance

func (UpgradeInstanceRequest) MarshalJSON added in v0.65.0 

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

type UpgradeRuntimeRequest added in v0.100.0 

type UpgradeRuntimeRequest struct {
	// RequestId: Idempotent request UUID.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

UpgradeRuntimeRequest: Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";

func (UpgradeRuntimeRequest) MarshalJSON added in v0.100.0 

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

type VertexAIParameters added in v0.58.0 

type VertexAIParameters struct {
	// Env: Environment variables. At most 100 environment variables can be
	// specified and unique. Example: `GCP_BUCKET=gs://my-bucket/samples/`
	Env map[string]string `json:"env,omitempty"`
	// Network: The full name of the Compute Engine network
	// (https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to
	// which the Job should be peered. For example,
	// `projects/12345/global/networks/myVPC`. Format
	// (https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is
	// of the form `projects/{project}/global/networks/{network}`. Where
	// `{project}` is a project number, as in `12345`, and `{network}` is a network
	// name. Private services access must already be configured for the network. If
	// left unspecified, the job is not peered with any network.
	Network string `json:"network,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Env") 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. "Env") 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:"-"`
}

VertexAIParameters: Parameters used in Vertex AI JobType executions.

func (VertexAIParameters) MarshalJSON added in v0.58.0 

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

type VirtualMachine added in v0.44.0 

type VirtualMachine struct {
	// InstanceId: Output only. The unique identifier of the Managed Compute Engine
	// instance.
	InstanceId string `json:"instanceId,omitempty"`
	// InstanceName: Output only. The user-friendly name of the Managed Compute
	// Engine instance.
	InstanceName string `json:"instanceName,omitempty"`
	// VirtualMachineConfig: Virtual Machine configuration settings.
	VirtualMachineConfig *VirtualMachineConfig `json:"virtualMachineConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InstanceId") 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. "InstanceId") 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:"-"`
}

VirtualMachine: Runtime using Virtual Machine for computing.

func (VirtualMachine) MarshalJSON added in v0.44.0 

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

type VirtualMachineConfig added in v0.44.0 

type VirtualMachineConfig struct {
	// AcceleratorConfig: Optional. The Compute Engine accelerator configuration
	// for this runtime.
	AcceleratorConfig *RuntimeAcceleratorConfig `json:"acceleratorConfig,omitempty"`
	// BootImage: Optional. Boot image metadata used for runtime upgradeability.
	BootImage *BootImage `json:"bootImage,omitempty"`
	// ContainerImages: Optional. Use a list of container images to use as Kernels
	// in the notebook instance.
	ContainerImages []*ContainerImage `json:"containerImages,omitempty"`
	// DataDisk: Required. Data disk option configuration settings.
	DataDisk *LocalDisk `json:"dataDisk,omitempty"`
	// EncryptionConfig: Optional. Encryption settings for virtual machine data
	// disk.
	EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
	// GuestAttributes: Output only. The Compute Engine guest attributes. (see
	// Project and instance guest attributes
	// (https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
	GuestAttributes map[string]string `json:"guestAttributes,omitempty"`
	// InternalIpOnly: Optional. If true, runtime will only have internal IP
	// addresses. By default, runtimes are not restricted to internal IP addresses,
	// and will have ephemeral external IP addresses assigned to each vm. This
	// `internal_ip_only` restriction can only be enabled for subnetwork enabled
	// networks, and all dependencies must be configured to be accessible without
	// external IP addresses.
	InternalIpOnly bool `json:"internalIpOnly,omitempty"`
	// Labels: Optional. The labels to associate with this runtime. Label **keys**
	// must contain 1 to 63 characters, and must conform to RFC 1035
	// (https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but,
	// if present, must contain 1 to 63 characters, and must conform to RFC 1035
	// (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
	// associated with a cluster.
	Labels map[string]string `json:"labels,omitempty"`
	// MachineType: Required. The Compute Engine machine type used for runtimes.
	// Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`
	MachineType string `json:"machineType,omitempty"`
	// Metadata: Optional. The Compute Engine metadata entries to add to virtual
	// machine. (see Project and instance metadata
	// (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
	Metadata map[string]string `json:"metadata,omitempty"`
	// Network: Optional. The Compute Engine network to be used for machine
	// communications. Cannot be specified with subnetwork. If neither `network`
	// nor `subnet` is specified, the "default" network of the project is used, if
	// it exists. A full URL or partial URI. Examples: *
	// `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/
	// default` * `projects/[project_id]/global/networks/default` Runtimes are
	// managed resources inside Google Infrastructure. Runtimes support the
	// following network configurations: * Google Managed Network (Network & subnet
	// are empty) * Consumer Project VPC (network & subnet are required). Requires
	// configuring Private Service Access. * Shared VPC (network & subnet are
	// required). Requires configuring Private Service Access.
	Network string `json:"network,omitempty"`
	// NicType: Optional. The type of vNIC to be used on this interface. This may
	// be gVNIC or VirtioNet.
	//
	// Possible values:
	//   "UNSPECIFIED_NIC_TYPE" - No type specified.
	//   "VIRTIO_NET" - VIRTIO
	//   "GVNIC" - GVNIC
	NicType string `json:"nicType,omitempty"`
	// ReservedIpRange: Optional. Reserved IP Range name is used for VPC Peering.
	// The subnetwork allocation will use the range *name* if it's assigned.
	// Example: managed-notebooks-range-c
	// PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses
	// create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \
	// --description="Google Cloud Managed Notebooks Range 24 c" \
	// --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field
	// value will be: `managed-notebooks-range-c`
	ReservedIpRange string `json:"reservedIpRange,omitempty"`
	// ShieldedInstanceConfig: Optional. Shielded VM Instance configuration
	// settings.
	ShieldedInstanceConfig *RuntimeShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"`
	// Subnet: Optional. The Compute Engine subnetwork to be used for machine
	// communications. Cannot be specified with network. A full URL or partial URI
	// are valid. Examples: *
	// `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1
	// /subnetworks/sub0` *
	// `projects/[project_id]/regions/us-east1/subnetworks/sub0`
	Subnet string `json:"subnet,omitempty"`
	// Tags: Optional. The Compute Engine network tags to add to runtime (see Add
	// network tags (https://cloud.google.com/vpc/docs/add-remove-network-tags)).
	Tags []string `json:"tags,omitempty"`
	// Zone: Output only. The zone where the virtual machine is located. If using
	// regional request, the notebooks service will pick a location in the
	// corresponding runtime region. On a get request, zone will always be present.
	// Example: * `us-central1-b`
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AcceleratorConfig") 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. "AcceleratorConfig") 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:"-"`
}

VirtualMachineConfig: The config settings for virtual machine.

func (VirtualMachineConfig) MarshalJSON added in v0.44.0 

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

type VmImage 

type VmImage struct {
	// ImageFamily: Use this VM image family to find the image; the newest image in
	// this family will be used.
	ImageFamily string `json:"imageFamily,omitempty"`
	// ImageName: Use VM image name to find the image.
	ImageName string `json:"imageName,omitempty"`
	// Project: Required. The name of the Google Cloud project that this VM image
	// belongs to. Format: `{project_id}`
	Project string `json:"project,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ImageFamily") 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. "ImageFamily") 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:"-"`
}

VmImage: Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

func (VmImage) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.