Namespace Google.Cloud.Notebooks.V1 (2.0.0-beta01)

Classes

ContainerImage

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

CreateEnvironmentRequest

Request for creating a notebook environment.

CreateExecutionRequest

Request to create notebook execution

CreateInstanceRequest

Request for creating a notebook instance.

CreateRuntimeRequest

Request for creating a Managed Notebook Runtime.

CreateScheduleRequest

Request for created scheduled notebooks

DeleteEnvironmentRequest

Request for deleting a notebook environment.

DeleteExecutionRequest

Request for deleting a scheduled notebook execution

DeleteInstanceRequest

Request for deleting a notebook instance.

DeleteRuntimeRequest

Request for deleting a Managed Notebook Runtime.

DeleteScheduleRequest

Request for deleting an Schedule

EncryptionConfig

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

Environment

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

EnvironmentName

Resource name for the Environment resource.

Event

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

Event.Types

Container for nested types declared in the Event message type.

Execution

The definition of a single executed notebook.

Execution.Types

Container for nested types declared in the Execution message type.

ExecutionName

Resource name for the Execution resource.

ExecutionTemplate

The description a notebook execution workload.

ExecutionTemplate.Types

Container for nested types declared in the ExecutionTemplate message type.

ExecutionTemplate.Types.DataprocParameters

Parameters used in Dataproc JobType executions.

ExecutionTemplate.Types.SchedulerAcceleratorConfig

Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.

ExecutionTemplate.Types.VertexAIParameters

Parameters used in Vertex AI JobType executions.

GetEnvironmentRequest

Request for getting a notebook environment.

GetExecutionRequest

Request for getting scheduled notebook execution

GetInstanceHealthRequest

Request for checking if a notebook instance is healthy.

GetInstanceHealthResponse

Response for checking if a notebook instance is healthy.

GetInstanceHealthResponse.Types

Container for nested types declared in the GetInstanceHealthResponse message type.

GetInstanceRequest

Request for getting a notebook instance.

GetRuntimeRequest

Request for getting a Managed Notebook Runtime.

GetScheduleRequest

Request for getting scheduled notebook.

Instance

The definition of a notebook instance.

Instance.Types

Container for nested types declared in the Instance message type.

Instance.Types.AcceleratorConfig

Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.

Instance.Types.Disk

An instance-attached disk resource.

Instance.Types.Disk.Types

Container for nested types declared in the Disk message type.

Instance.Types.Disk.Types.GuestOsFeature

Guest OS features for boot disk.

Instance.Types.ShieldedInstanceConfig

A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.

Instance.Types.UpgradeHistoryEntry

The entry of VM image upgrade history.

Instance.Types.UpgradeHistoryEntry.Types

Container for nested types declared in the UpgradeHistoryEntry message type.

InstanceConfig

Notebook instance configurations that can be updated.

InstanceName

Resource name for the Instance resource.

IsInstanceUpgradeableRequest

Request for checking if a notebook instance is upgradeable.

IsInstanceUpgradeableResponse

Response for checking if a notebook instance is upgradeable.

ListEnvironmentsRequest

Request for listing environments.

ListEnvironmentsResponse

Response for listing environments.

ListExecutionsRequest

Request for listing scheduled notebook executions.

ListExecutionsResponse

Response for listing scheduled notebook executions

ListInstancesRequest

Request for listing notebook instances.

ListInstancesResponse

Response for listing notebook instances.

ListRuntimesRequest

Request for listing Managed Notebook Runtimes.

ListRuntimesResponse

Response for listing Managed Notebook Runtimes.

ListSchedulesRequest

Request for listing scheduled notebook job.

ListSchedulesResponse

Response for listing scheduled notebook job.

LocalDisk

A Local attached disk resource.

LocalDisk.Types

Container for nested types declared in the LocalDisk message type.

LocalDisk.Types.RuntimeGuestOsFeature

Optional. 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. Guest OS features for boot disk.

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.

LocalDiskInitializeParams.Types

Container for nested types declared in the LocalDiskInitializeParams message type.

ManagedNotebookService

API v1 service for Managed Notebooks.

ManagedNotebookService.ManagedNotebookServiceBase

Base class for server-side implementations of ManagedNotebookService

ManagedNotebookService.ManagedNotebookServiceClient

Client for ManagedNotebookService

ManagedNotebookServiceClient

ManagedNotebookService client wrapper, for convenient use.

ManagedNotebookServiceClientBuilder

Builder class for ManagedNotebookServiceClient to provide simple configuration of credentials, endpoint etc.

ManagedNotebookServiceClientImpl

ManagedNotebookService client wrapper implementation, for convenient use.

ManagedNotebookServiceSettings

Settings for ManagedNotebookServiceClient instances.

NotebookService

API v1 service for Cloud AI Platform Notebooks.

NotebookService.NotebookServiceBase

Base class for server-side implementations of NotebookService

NotebookService.NotebookServiceClient

Client for NotebookService

NotebookServiceClient

NotebookService client wrapper, for convenient use.

NotebookServiceClientBuilder

Builder class for NotebookServiceClient to provide simple configuration of credentials, endpoint etc.

NotebookServiceClientImpl

NotebookService client wrapper implementation, for convenient use.

NotebookServiceSettings

Settings for NotebookServiceClient instances.

OperationMetadata

Represents the metadata of the long-running operation.

RefreshRuntimeTokenInternalRequest

Request for getting a new access token.

RefreshRuntimeTokenInternalResponse

Response with a new access token.

RegisterInstanceRequest

Request for registering a notebook instance.

ReportInstanceInfoRequest

Request for notebook instances to report information to Notebooks API.

ReportRuntimeEventRequest

Request for reporting a Managed Notebook Event.

ReservationAffinity

Reservation Affinity for consuming Zonal reservation.

ReservationAffinity.Types

Container for nested types declared in the ReservationAffinity message type.

ResetInstanceRequest

Request for resetting a notebook instance

ResetRuntimeRequest

Request for resetting a Managed Notebook Runtime.

RollbackInstanceRequest

Request for rollbacking a notebook instance

Runtime

The definition of a Runtime for a managed notebook instance.

Runtime.Types

Container for nested types declared in the Runtime message type.

RuntimeAcceleratorConfig

Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See Compute Engine AcceleratorTypes. Examples:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100

RuntimeAcceleratorConfig.Types

Container for nested types declared in the RuntimeAcceleratorConfig message type.

RuntimeAccessConfig

Specifies the login configuration for Runtime

RuntimeAccessConfig.Types

Container for nested types declared in the RuntimeAccessConfig message type.

RuntimeMetrics

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

RuntimeName

Resource name for the Runtime resource.

RuntimeShieldedInstanceConfig

A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.

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

Schedule

The definition of a schedule.

Schedule.Types

Container for nested types declared in the Schedule message type.

ScheduleName

Resource name for the Schedule resource.

SetInstanceAcceleratorRequest

Request for setting instance accelerator.

SetInstanceLabelsRequest

Request for setting instance labels.

SetInstanceMachineTypeRequest

Request for setting instance machine type.

StartInstanceRequest

Request for starting a notebook instance

StartRuntimeRequest

Request for starting a Managed Notebook Runtime.

StopInstanceRequest

Request for stopping a notebook instance

StopRuntimeRequest

Request for stopping a Managed Notebook Runtime.

SwitchRuntimeRequest

Request for switching a Managed Notebook Runtime.

TensorboardName

Resource name for the Tensorboard resource.

TriggerScheduleRequest

Request for created scheduled notebooks

UpdateInstanceConfigRequest

Request for updating instance configurations.

UpdateInstanceMetadataItemsRequest

Request for adding/changing metadata items for an instance.

UpdateInstanceMetadataItemsResponse

Response for adding/changing metadata items for an instance.

UpdateShieldedInstanceConfigRequest

Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance

UpgradeInstanceInternalRequest

Request for upgrading a notebook instance from within the VM

UpgradeInstanceRequest

Request for upgrading a notebook instance

VirtualMachine

Runtime using Virtual Machine for computing.

VirtualMachineConfig

The config settings for virtual machine.

VirtualMachineConfig.Types

Container for nested types declared in the VirtualMachineConfig message type.

VirtualMachineConfig.Types.BootImage

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

VmImage

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Enums

Environment.ImageTypeOneofCase

Enum of possible cases for the "image_type" oneof.

EnvironmentName.ResourceNameType

The possible contents of EnvironmentName.

Event.Types.EventType

The definition of the event types.

Execution.Types.State

Enum description of the state of the underlying AIP job.

ExecutionName.ResourceNameType

The possible contents of ExecutionName.

ExecutionTemplate.JobParametersOneofCase

Enum of possible cases for the "job_parameters" oneof.

ExecutionTemplate.Types.JobType

The backend used for this execution.

ExecutionTemplate.Types.ScaleTier

Required. Specifies the machine types, the number of replicas for workers and parameter servers.

ExecutionTemplate.Types.SchedulerAcceleratorType

Hardware accelerator types for AI Platform Training jobs.

GetInstanceHealthResponse.Types.HealthState

If an instance is healthy or not.

Instance.EnvironmentOneofCase

Enum of possible cases for the "environment" oneof.

Instance.Types.AcceleratorType

Definition of the types of hardware accelerators that can be used on this instance.

Instance.Types.DiskEncryption

Definition of the disk encryption options.

Instance.Types.DiskType

Possible disk types for notebook instances.

Instance.Types.NicType

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

Instance.Types.State

The definition of the states of this instance.

Instance.Types.UpgradeHistoryEntry.Types.Action

The definition of operations of this upgrade history entry.

Instance.Types.UpgradeHistoryEntry.Types.State

The definition of the states of this upgrade history entry.

InstanceName.ResourceNameType

The possible contents of InstanceName.

LocalDiskInitializeParams.Types.DiskType

Possible disk types.

ReservationAffinity.Types.Type

Indicates whether to consume capacity from an reservation or not.

Runtime.RuntimeTypeOneofCase

Enum of possible cases for the "runtime_type" oneof.

Runtime.Types.HealthState

The runtime substate.

Runtime.Types.State

The definition of the states of this runtime.

RuntimeAcceleratorConfig.Types.AcceleratorType

Type of this accelerator.

RuntimeAccessConfig.Types.RuntimeAccessType

Possible ways to access runtime. Authentication mode. Currently supports: Single User only.

RuntimeName.ResourceNameType

The possible contents of RuntimeName.

Schedule.Types.State

State of the job.

ScheduleName.ResourceNameType

The possible contents of ScheduleName.

TensorboardName.ResourceNameType

The possible contents of TensorboardName.

UpgradeType

Definition of the types of upgrade that can be used on this instance.

VirtualMachineConfig.Types.NicType

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

VmImage.ImageOneofCase

Enum of possible cases for the "image" oneof.