Package google.cloud.notebooks.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

ManagedNotebookService

API v1 service for Managed Notebooks.

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

Creates a new Runtime in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteRuntime

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

Deletes a single Runtime.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetRuntime

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListRuntimes

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

Lists Runtimes in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ReportRuntimeEvent

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

Report and process a runtime event.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ResetRuntime

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

Resets a Managed Notebook Runtime.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SwitchRuntime

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

Switch a Managed Notebook Runtime.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateRuntime

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

Update Notebook Runtime configuration.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

NotebookService

API v1 service for Cloud AI Platform Notebooks.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

Creates a new Environment.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateExecution

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

Creates a new Execution in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Creates a new Instance in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateSchedule

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

Creates a new Scheduled Notebook in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteEnvironment

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

Deletes a single Environment.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

Deletes execution

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Deletes a single Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteSchedule

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

Deletes schedule and all underlying jobs

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

Gets details of a single Environment.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetExecution

rpc GetExecution(GetExecutionRequest) returns (Execution)

Gets details of executions

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Gets details of a single Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetInstanceHealth

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

Check if a notebook instance is healthy.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetSchedule

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

Gets details of schedule

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IsInstanceUpgradeable

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

Check if a notebook instance is upgradable.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListEnvironments

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

Lists environments in a project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListExecutions

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

Lists executions in a given project and location

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Lists instances in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListSchedules

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

Lists schedules in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Resets a notebook instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Rollbacks a notebook instance to the previous version.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetInstanceAccelerator

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

Updates the guest accelerators of a single Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetInstanceLabels

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

Replaces all the labels of an Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetInstanceMachineType

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation)

Updates the machine type of a single Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Starts a notebook instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Stops a notebook instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateInstanceConfig

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

Update Notebook Instance configurations.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateInstanceMetadataItems

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

Add/update metadata items for an instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateShieldedInstanceConfig

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

Updates the Shielded instance configuration of a single Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Upgrades a notebook instance to the latest version.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpgradeInstanceInternal

rpc UpgradeInstanceInternal(UpgradeInstanceInternalRequest) returns (Operation)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ContainerImage

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

Fields
repository

string

Required. The path to the container image repository. For example: gcr.io/{project_id}/{image_name}

tag

string

The tag of the container image. If not specified, this defaults to the latest tag.

CreateEnvironmentRequest

Request for creating a notebook environment.

Fields
parent

string

Required. Format: projects/{project_id}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.environments.create
environment_id

string

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.

environment

Environment

Required. The environment to be created.

CreateExecutionRequest

Request to create notebook execution

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.executions.create
execution_id

string

Required. User-defined unique ID of this execution.

execution

Execution

Required. The execution to be created.

CreateInstanceRequest

Request for creating a notebook instance.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.instances.create
instance_id

string

Required. User-defined unique ID of this instance.

instance

Instance

Required. The instance to be created.

CreateRuntimeRequest

Request for creating a Managed Notebook Runtime.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.runtimes.create
runtime_id

string

Required. User-defined unique ID of this Runtime.

runtime

Runtime

Required. The Runtime to be created.

request_id

string

Idempotent request UUID.

CreateScheduleRequest

Request for created scheduled notebooks

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.schedules.create
schedule_id

string

Required. User-defined unique ID of this schedule.

schedule

Schedule

Required. The schedule to be created.

DeleteEnvironmentRequest

Request for deleting a notebook environment.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.environments.delete

DeleteExecutionRequest

Request for deleting a scheduled notebook execution

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.executions.delete

DeleteInstanceRequest

Request for deleting a notebook instance.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.instances.delete

DeleteRuntimeRequest

Request for deleting a Managed Notebook Runtime.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.runtimes.delete
request_id

string

Idempotent request UUID.

DeleteScheduleRequest

Request for deleting an Schedule

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.schedules.delete

DiagnoseInstanceRequest

Request for creating a notebook instance diagnostic file.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnostic_config

DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

DiagnosticConfig

Defines flags that are used to run the diagnostic tool

Fields
gcs_bucket

string

Required. User Cloud Storage bucket location (REQUIRED)

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

Cloud Storage bucket Log file will be written to gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz

relative_path

string

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/

repair_flag_enabled

bool

Optional. Enables flag to repair service for instance

packet_capture_flag_enabled

bool

Optional. Enables flag to capture packets from the instance for 30 seconds

copy_home_files_flag_enabled

bool

Optional. Enables flag to copy all /home/jupyter folder contents

EncryptionConfig

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

Fields
kms_key

string

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}

Environment

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

Fields
name

string

Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

display_name

string

Display name of this environment for the UI.

description

string

A brief description of this environment.

post_startup_script

string

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"

create_time

Timestamp

Output only. The time at which this environment was created.

Union field image_type. Type of the environment; can be one of VM image, or container image. image_type can be only one of the following:
vm_image

VmImage

Use a Compute Engine VM image to start the notebook instance.

container_image

ContainerImage

Use a container image to start the notebook instance.

Event

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

Fields
report_time

Timestamp

Event report time.

type

EventType

Event type.

details

map<string, string>

Optional. Event details. This field is used to pass event information.

EventType

The definition of the event types.

Enums
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

Execution

The definition of a single executed notebook.

Fields
execution_template

ExecutionTemplate

execute metadata including name, hardware spec, region, labels, etc.

name

string

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

display_name

string

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

description

string

A brief description of this execution.

create_time

Timestamp

Output only. Time the Execution was instantiated.

update_time

Timestamp

Output only. Time the Execution was last updated.

state

State

Output only. State of the underlying AI Platform job.

output_notebook_file

string

Output notebook file generated by this execution

job_uri

string

Output only. The URI of the external job used to execute the notebook.

State

Enum description of the state of the underlying AIP job.

Enums
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.

ExecutionTemplate

The description a notebook execution workload.

Fields
scale_tier
(deprecated)

ScaleTier

Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.

master_type

string

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.

accelerator_config

SchedulerAcceleratorConfig

Configuration (count and accelerator type) for hardware running notebook execution.

labels

map<string, string>

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.

input_notebook_file

string

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

container_image_uri

string

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

output_notebook_folder

string

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

params_yaml_file

string

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

parameters

string

Parameters used within the 'input_notebook_file' notebook.

service_account

string

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.

job_type

JobType

The type of Job to be used on this execution.

kernel_spec

string

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.

tensorboard

string

The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Union field job_parameters. Parameters for an execution type. NOTE: There are currently no extra parameters for VertexAI jobs. job_parameters can be only one of the following:
dataproc_parameters

DataprocParameters

Parameters used in Dataproc JobType executions.

vertex_ai_parameters

VertexAIParameters

Parameters used in Vertex AI JobType executions.

DataprocParameters

Parameters used in Dataproc JobType executions.

Fields
cluster

string

URI for cluster used to run Dataproc execution. Format: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

The backend used for this execution.

Enums
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

ScaleTier

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

Enums
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.

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.

Fields
type

SchedulerAcceleratorType

Type of this accelerator.

core_count

int64

Count of cores of this accelerator.

SchedulerAcceleratorType

Hardware accelerator types for AI Platform Training jobs.

Enums
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.

VertexAIParameters

Parameters used in Vertex AI JobType executions.

Fields
network

string

The full name of the Compute Engine network to which the Job should be peered. For example, projects/12345/global/networks/myVPC. Format 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.

env

map<string, string>

Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

Request for getting a notebook environment.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.environments.get

GetExecutionRequest

Request for getting scheduled notebook execution

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.executions.get

GetInstanceHealthRequest

Request for checking if a notebook instance is healthy.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.instances.getHealth

GetInstanceHealthResponse

Response for checking if a notebook instance is healthy.

Fields
health_state

HealthState

Output only. Runtime health_state.

health_info

map<string, string>

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" }

HealthState

If an instance is healthy or not.

Enums
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.

GetInstanceRequest

Request for getting a notebook instance.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.instances.get

GetRuntimeRequest

Request for getting a Managed Notebook Runtime.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.runtimes.get

GetScheduleRequest

Request for getting scheduled notebook.

Fields
name

string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.schedules.get

Instance

The definition of a notebook instance.

Fields
name

string

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

post_startup_script

string

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).

proxy_uri

string

Output only. The proxy endpoint that is used to access the Jupyter notebook.

instance_owners[]

string

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.

service_account

string

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 is used.

service_account_scopes[]

string

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the following scopes 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

machine_type

string

Required. The Compute Engine machine type of this instance.

accelerator_config

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.

state

State

Output only. The state of this instance.

install_gpu_driver

bool

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.

custom_gpu_driver_path

string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

boot_disk_type

DiskType

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

boot_disk_size_gb

int64

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.

data_disk_type

DiskType

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

data_disk_size_gb

int64

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.

no_remove_data_disk

bool

Input only. If true, the data disk will not be auto deleted when deleting the instance.

disk_encryption

DiskEncryption

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

kms_key

string

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.

disks[]

Disk

Output only. Attached disks to notebook instance.

shielded_instance_config

ShieldedInstanceConfig

Optional. Shielded VM configuration. Images using supported Shielded VM features.

no_public_ip

bool

If true, no public IP will be assigned to this instance.

no_proxy_access

bool

If true, the notebook instance will not register with the proxy.

network

string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

subnet

string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

labels

map<string, string>

Labels to apply to this instance. These can be later modified by the setLabels method.

metadata

map<string, string>

Custom metadata to apply to this instance.

tags[]

string

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

upgrade_history[]

UpgradeHistoryEntry

The upgrade history of this instance.

nic_type

NicType

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

reservation_affinity

ReservationAffinity

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

creator

string

Output only. Email address of entity that sent original CreateInstance request.

can_ip_forward

bool

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

create_time

Timestamp

Output only. Instance creation time.

update_time

Timestamp

Output only. Instance update time.

Union field environment. Type of the environment; can be one of VM image, or container image. environment can be only one of the following:
vm_image

VmImage

Use a Compute Engine VM image to start the notebook instance.

container_image

ContainerImage

Use a container image to start the notebook instance.

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.

Fields
type

AcceleratorType

Type of this accelerator.

core_count

int64

Count of cores of this accelerator.

AcceleratorType

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

Enums
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_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.
TPU_V2 (Coming soon) Accelerator type is TPU V2.
TPU_V3 (Coming soon) Accelerator type is TPU V3.

Disk

An instance-attached disk resource.

Fields
auto_delete

bool

Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

boot

bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

device_name

string

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.

disk_size_gb

int64

Indicates the size of the disk in base-2 GB.

guest_os_features[]

GuestOsFeature

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.

index

int64

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.

interface

string

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
kind

string

Type of the resource. Always compute#attachedDisk for attached disks.

licenses[]

string

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

mode

string

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
source

string

Indicates a valid partial or full URL to an existing Persistent Disk resource.

type

string

Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

Guest OS features for boot disk.

Fields
type

string

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

DiskEncryption

Definition of the disk encryption options.

Enums
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.

DiskType