API documentation for notebooks_v1.types package.
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. .. attribute:: parent
Required. Format:
projects/{project_id}/locations/{location}
:type: str
CreateExecutionRequest
Request to create notebook execution .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
CreateInstanceRequest
Request for creating a notebook instance. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
CreateRuntimeRequest
Request for creating a Managed Notebook Runtime. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
CreateScheduleRequest
Request for created scheduled notebooks .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
DeleteEnvironmentRequest
Request for deleting a notebook environment. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/environments/{environment_id}
:type: str
DeleteExecutionRequest
Request for deleting a scheduled notebook execution .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/executions/{execution_id}
:type: str
DeleteInstanceRequest
Request for deleting a notebook instance. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
DeleteRuntimeRequest
Request for deleting a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
DeleteScheduleRequest
Request for deleting an Schedule .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
:type: str
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.
Event
The definition of an Event for a managed / semi-managed notebook instance.
Execution
The definition of a single executed notebook. .. attribute:: execution_template
execute metadata including name, hardware spec, region, labels, etc.
ExecutionTemplate
The description a notebook execution workload. .. attribute:: scale_tier
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
:type: google.cloud.notebooks_v1.types.ExecutionTemplate.ScaleTier
GetEnvironmentRequest
Request for getting a notebook environment. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/environments/{environment_id}
:type: str
GetExecutionRequest
Request for getting scheduled notebook execution .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/executions/{execution_id}
:type: str
GetInstanceHealthRequest
Request for checking if a notebook instance is healthy. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
GetInstanceHealthResponse
Response for checking if a notebook instance is healthy. .. attribute:: health_state
Output only. Runtime health_state.
:type: google.cloud.notebooks_v1.types.GetInstanceHealthResponse.HealthState
GetInstanceRequest
Request for getting a notebook instance. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
GetRuntimeRequest
Request for getting a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
GetScheduleRequest
Request for getting scheduled notebook. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
:type: str
Instance
The definition of a notebook instance.
InstanceConfig
Notebook instance configurations that can be updated. .. attribute:: notebook_upgrade_schedule
Cron expression in UTC timezone, used to schedule instance
auto upgrade. Please follow the cron
format <https://en.wikipedia.org/wiki/Cron>__.
:type: str
IsInstanceUpgradeableRequest
Request for checking if a notebook instance is upgradeable. .. attribute:: notebook_instance
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
IsInstanceUpgradeableResponse
Response for checking if a notebook instance is upgradeable. .. attribute:: upgradeable
If an instance is upgradeable.
:type: bool
ListEnvironmentsRequest
Request for listing environments. .. attribute:: parent
Required. Format:
projects/{project_id}/locations/{location}
:type: str
ListEnvironmentsResponse
Response for listing environments. .. attribute:: environments
A list of returned environments.
:type: Sequence[google.cloud.notebooks_v1.types.Environment]
ListExecutionsRequest
Request for listing scheduled notebook executions. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
ListExecutionsResponse
Response for listing scheduled notebook executions .. attribute:: executions
A list of returned instances.
:type: Sequence[google.cloud.notebooks_v1.types.Execution]
ListInstancesRequest
Request for listing notebook instances. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
ListInstancesResponse
Response for listing notebook instances. .. attribute:: instances
A list of returned instances.
:type: Sequence[google.cloud.notebooks_v1.types.Instance]
ListRuntimesRequest
Request for listing Managed Notebook Runtimes. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
ListRuntimesResponse
Response for listing Managed Notebook Runtimes. .. attribute:: runtimes
A list of returned Runtimes.
:type: Sequence[google.cloud.notebooks_v1.types.Runtime]
ListSchedulesRequest
Request for listing scheduled notebook job. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
ListSchedulesResponse
Response for listing scheduled notebook job. .. attribute:: schedules
A list of returned instances.
:type: Sequence[google.cloud.notebooks_v1.types.Schedule]
LocalDisk
An Local attached disk resource. .. attribute:: auto_delete
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).
:type: bool
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.
OperationMetadata
Represents the metadata of the long-running operation. .. attribute:: create_time
The time the operation was created.
:type: google.protobuf.timestamp_pb2.Timestamp
RegisterInstanceRequest
Request for registering a notebook instance. .. attribute:: parent
Required. Format:
parent=projects/{project_id}/locations/{location}
:type: str
ReportInstanceInfoRequest
Request for notebook instances to report information to Notebooks API.
ReportRuntimeEventRequest
Request for reporting a Managed Notebook Event. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
ResetInstanceRequest
Request for reseting a notebook instance .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
ResetRuntimeRequest
Request for reseting a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
RollbackInstanceRequest
Request for rollbacking a notebook instance .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
Runtime
The definition of a Runtime for a managed notebook instance. .. attribute:: name
Output only. The resource name of the runtime. Format:
projects/{project}/locations/{location}/runtimes/{runtimeId}
:type: str
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 <https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes>__.
Examples:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-t4nvidia-tesla-a100
RuntimeAccessConfig
Specifies the login configuration for Runtime .. attribute:: access_type
The type of access mode this instance.
:type: google.cloud.notebooks_v1.types.RuntimeAccessConfig.RuntimeAccessType
RuntimeMetrics
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
RuntimeShieldedInstanceConfig
A set of Shielded Instance options. Check Images using supported
Shielded VM
features <https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>__.
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: trueidle_shutdown_timeout: 180report-system-health: true
Schedule
The definition of a schedule. .. attribute:: name
Output only. The name of this schedule. Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
:type: str
SetInstanceAcceleratorRequest
Request for setting instance accelerator. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
SetInstanceLabelsRequest
Request for setting instance labels. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
SetInstanceMachineTypeRequest
Request for setting instance machine type. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
StartInstanceRequest
Request for starting a notebook instance .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
StartRuntimeRequest
Request for starting a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
StopInstanceRequest
Request for stopping a notebook instance .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
StopRuntimeRequest
Request for stopping a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
SwitchRuntimeRequest
Request for switching a Managed Notebook Runtime. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/runtimes/{runtime_id}
:type: str
TriggerScheduleRequest
Request for created scheduled notebooks .. attribute:: name
Required. Format:
parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}
:type: str
UpdateInstanceConfigRequest
Request for updating instance configurations. .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
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 .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
UpgradeInstanceRequest
Request for upgrading a notebook instance .. attribute:: name
Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
:type: str
VirtualMachine
Runtime using Virtual Machine for computing. .. attribute:: instance_name
Output only. The user-friendly name of the Managed Compute Engine instance.
:type: str
VirtualMachineConfig
The config settings for virtual machine. .. attribute:: 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:type: str
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.