Package types (1.5.1)

Version 1.5.1

• 1.12.0 (latest)
• 1.11.1
• 1.10.5
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.1
• 1.5.1
• 1.4.4
• 1.3.2
• 1.2.1
• 1.1.1
• 1.0.0
• 0.4.3
• 0.3.2
• 0.2.0
• 0.1.2

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.

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

DiagnoseInstanceRequest

Request for creating a notebook instance diagnostic file.

DiagnoseRuntimeRequest

Request for creating a notebook instance diagnostic file.

DiagnosticConfig

Defines flags that are used to run the diagnostic tool

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Event

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

Execution

The definition of a single executed notebook.

ExecutionTemplate

The description a notebook execution workload.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceConfig

Notebook instance configurations that can be updated.

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.

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.

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.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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-k80
• nvidia-tesla-p100
• nvidia-tesla-v100
• nvidia-tesla-p4
• nvidia-tesla-t4
• nvidia-tesla-a100

RuntimeAccessConfig

Specifies the login configuration for Runtime

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: true
• idle_shutdown_timeout: 180
• enable_health_monitoring: true

Schedule

The definition of a schedule.

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.

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.

UpdateRuntimeRequest

Request for updating a Managed Notebook configuration.

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

UpgradeRuntimeRequest

Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";

UpgradeType

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

VirtualMachine

Runtime using Virtual Machine for computing.

VirtualMachineConfig

The config settings for virtual machine.

VmImage

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields