# Package Classes (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.3 1.12.0 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 Summary of entries of Classes for notebooks.

## Classes

### [ManagedNotebookServiceAsyncClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient)

API v1 service for Managed Notebooks.

### [ManagedNotebookServiceClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient)

API v1 service for Managed Notebooks.

### [ListRuntimesAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesAsyncPager)

A pager for iterating through `list_runtimes` requests.

This class thinly wraps an initial
[ListRuntimesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesResponse) object, and
provides an `__aiter__` method to iterate through its
`runtimes` field.

If there are more pages, the `__aiter__` method will make additional
`ListRuntimes` requests and continue to iterate
through the `runtimes` field on the
corresponding responses.

All the usual [ListRuntimesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListRuntimesPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesPager)

A pager for iterating through `list_runtimes` requests.

This class thinly wraps an initial
[ListRuntimesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesResponse) object, and
provides an `__iter__` method to iterate through its
`runtimes` field.

If there are more pages, the `__iter__` method will make additional
`ListRuntimes` requests and continue to iterate
through the `runtimes` field on the
corresponding responses.

All the usual [ListRuntimesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [NotebookServiceAsyncClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient)

API v1 service for Cloud AI Platform Notebooks.

### [NotebookServiceClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient)

API v1 service for Cloud AI Platform Notebooks.

### [ListEnvironmentsAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsAsyncPager)

A pager for iterating through `list_environments` requests.

This class thinly wraps an initial
[ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsResponse) object, and
provides an `__aiter__` method to iterate through its
`environments` field.

If there are more pages, the `__aiter__` method will make additional
`ListEnvironments` requests and continue to iterate
through the `environments` field on the
corresponding responses.

All the usual [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListEnvironmentsPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsPager)

A pager for iterating through `list_environments` requests.

This class thinly wraps an initial
[ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsResponse) object, and
provides an `__iter__` method to iterate through its
`environments` field.

If there are more pages, the `__iter__` method will make additional
`ListEnvironments` requests and continue to iterate
through the `environments` field on the
corresponding responses.

All the usual [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListExecutionsAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsAsyncPager)

A pager for iterating through `list_executions` requests.

This class thinly wraps an initial
[ListExecutionsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsResponse) object, and
provides an `__aiter__` method to iterate through its
`executions` field.

If there are more pages, the `__aiter__` method will make additional
`ListExecutions` requests and continue to iterate
through the `executions` field on the
corresponding responses.

All the usual [ListExecutionsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListExecutionsPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsPager)

A pager for iterating through `list_executions` requests.

This class thinly wraps an initial
[ListExecutionsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsResponse) object, and
provides an `__iter__` method to iterate through its
`executions` field.

If there are more pages, the `__iter__` method will make additional
`ListExecutions` requests and continue to iterate
through the `executions` field on the
corresponding responses.

All the usual [ListExecutionsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListInstancesAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesAsyncPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesResponse) object, and
provides an `__aiter__` method to iterate through its
`instances` field.

If there are more pages, the `__aiter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListInstancesPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesResponse) object, and
provides an `__iter__` method to iterate through its
`instances` field.

If there are more pages, the `__iter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListSchedulesAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesAsyncPager)

A pager for iterating through `list_schedules` requests.

This class thinly wraps an initial
[ListSchedulesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesResponse) object, and
provides an `__aiter__` method to iterate through its
`schedules` field.

If there are more pages, the `__aiter__` method will make additional
`ListSchedules` requests and continue to iterate
through the `schedules` field on the
corresponding responses.

All the usual [ListSchedulesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListSchedulesPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesPager)

A pager for iterating through `list_schedules` requests.

This class thinly wraps an initial
[ListSchedulesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesResponse) object, and
provides an `__iter__` method to iterate through its
`schedules` field.

If there are more pages, the `__iter__` method will make additional
`ListSchedules` requests and continue to iterate
through the `schedules` field on the
corresponding responses.

All the usual [ListSchedulesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ContainerImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ContainerImage)

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

### [CreateEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.CreateEnvironmentRequest)

Request for creating a notebook environment.

### [CreateExecutionRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.CreateExecutionRequest)

Request to create notebook execution

### [CreateInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.CreateInstanceRequest)

Request for creating a notebook instance.

### [CreateRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.CreateRuntimeRequest)

Request for creating a Managed Notebook Runtime.

### [CreateScheduleRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.CreateScheduleRequest)

Request for created scheduled notebooks

### [DeleteEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DeleteEnvironmentRequest)

Request for deleting a notebook environment.

### [DeleteExecutionRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DeleteExecutionRequest)

Request for deleting a scheduled notebook execution

### [DeleteInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DeleteInstanceRequest)

Request for deleting a notebook instance.

### [DeleteRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DeleteRuntimeRequest)

Request for deleting a Managed Notebook Runtime.

### [DeleteScheduleRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DeleteScheduleRequest)

Request for deleting an Schedule

### [DiagnoseInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DiagnoseInstanceRequest)

Request for creating a notebook instance diagnostic file.

### [DiagnoseRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DiagnoseRuntimeRequest)

Request for creating a notebook instance diagnostic file.

### [DiagnosticConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.DiagnosticConfig)

Defines flags that are used to run the diagnostic tool

### [EncryptionConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.EncryptionConfig)

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

### [Environment](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Event)

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

### [DetailsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Event.DetailsEntry)

The abstract base class for a message.

### [EventType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Event.EventType)

The definition of the event types.

### [Execution](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Execution)

The definition of a single executed notebook.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Execution.State)

Enum description of the state of the underlying AIP job.

### [ExecutionTemplate](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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>

### [DataprocParameters](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.DataprocParameters)

Parameters used in Dataproc JobType executions.

### [JobType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.JobType)

The backend used for this execution.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.LabelsEntry)

The abstract base class for a message.

### [ScaleTier](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.ScaleTier)

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

        - You *must* set `ExecutionTemplate.masterType` to specify
          the type of machine to use for your master node. This is
          the only required setting.

### [SchedulerAcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.SchedulerAcceleratorConfig)

Definition of a hardware accelerator. Note that not all combinations
of `type` and `core_count` are valid. Check `GPUs on Compute
Engine <https://cloud.google.com/compute/docs/gpus>`__ to find a
valid combination. TPUs are not supported.

### [SchedulerAcceleratorType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.SchedulerAcceleratorType)

Hardware accelerator types for AI Platform Training jobs.

### [VertexAIParameters](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.VertexAIParameters)

Parameters used in Vertex AI JobType executions.

### [EnvEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ExecutionTemplate.VertexAIParameters.EnvEntry)

The abstract base class for a message.

### [GetEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetEnvironmentRequest)

Request for getting a notebook environment.

### [GetExecutionRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetExecutionRequest)

Request for getting scheduled notebook execution

### [GetInstanceHealthRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetInstanceHealthRequest)

Request for checking if a notebook instance is healthy.

### [GetInstanceHealthResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetInstanceHealthResponse)

Response for checking if a notebook instance is healthy.

### [HealthInfoEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetInstanceHealthResponse.HealthInfoEntry)

The abstract base class for a message.

### [HealthState](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetInstanceHealthResponse.HealthState)

If an instance is healthy or not.

### [GetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetInstanceRequest)

Request for getting a notebook instance.

### [GetRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetRuntimeRequest)

Request for getting a Managed Notebook Runtime.

### [GetScheduleRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.GetScheduleRequest)

Request for getting scheduled notebook.

### [Instance](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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>

### [AcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.AcceleratorConfig)

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

### [AcceleratorType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.AcceleratorType)

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

### [Disk](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.Disk)

An instance-attached disk resource.

### [GuestOsFeature](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.Disk.GuestOsFeature)

Guest OS features for boot disk.

### [DiskEncryption](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.DiskEncryption)

Definition of the disk encryption options.

### [DiskType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.DiskType)

Possible disk types for notebook instances.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.LabelsEntry)

The abstract base class for a message.

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.MetadataEntry)

The abstract base class for a message.

### [NicType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.NicType)

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

### [ShieldedInstanceConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.ShieldedInstanceConfig)

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.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.State)

The definition of the states of this instance.

### [UpgradeHistoryEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.UpgradeHistoryEntry)

The entry of VM image upgrade history.

### [Action](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.UpgradeHistoryEntry.Action)

The definition of operations of this upgrade history entry.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Instance.UpgradeHistoryEntry.State)

The definition of the states of this upgrade history entry.

### [InstanceConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.InstanceConfig)

Notebook instance configurations that can be updated.

### [IsInstanceUpgradeableRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.IsInstanceUpgradeableRequest)

Request for checking if a notebook instance is upgradeable.

### [IsInstanceUpgradeableResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.IsInstanceUpgradeableResponse)

Response for checking if a notebook instance is upgradeable.

### [ListEnvironmentsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsRequest)

Request for listing environments.

### [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListEnvironmentsResponse)

Response for listing environments.

### [ListExecutionsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsRequest)

Request for listing scheduled notebook executions.

### [ListExecutionsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListExecutionsResponse)

Response for listing scheduled notebook executions

### [ListInstancesRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesRequest)

Request for listing notebook instances.

### [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListInstancesResponse)

Response for listing notebook instances.

### [ListRuntimesRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesRequest)

Request for listing Managed Notebook Runtimes.

### [ListRuntimesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListRuntimesResponse)

Response for listing Managed Notebook Runtimes.

### [ListSchedulesRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesRequest)

Request for listing scheduled notebook job.

### [ListSchedulesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ListSchedulesResponse)

Response for listing scheduled notebook job.

### [LocalDisk](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.LocalDisk)

A Local attached disk resource.

### [RuntimeGuestOsFeature](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.LocalDisk.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.

### [LocalDiskInitializeParams](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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.

### [DiskType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.LocalDiskInitializeParams.DiskType)

Possible disk types.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.LocalDiskInitializeParams.LabelsEntry)

The abstract base class for a message.

### [OperationMetadata](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.OperationMetadata)

Represents the metadata of the long-running operation.

### [RefreshRuntimeTokenInternalRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RefreshRuntimeTokenInternalRequest)

Request for getting a new access token.

### [RefreshRuntimeTokenInternalResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RefreshRuntimeTokenInternalResponse)

Response with a new access token.

### [RegisterInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RegisterInstanceRequest)

Request for registering a notebook instance.

### [ReportInstanceInfoRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ReportInstanceInfoRequest)

Request for notebook instances to report information to
Notebooks API.

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ReportInstanceInfoRequest.MetadataEntry)

The abstract base class for a message.

### [ReportRuntimeEventRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ReportRuntimeEventRequest)

Request for reporting a Managed Notebook Event.

### [ReservationAffinity](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ReservationAffinity)

Reservation Affinity for consuming Zonal reservation.

### [Type](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ReservationAffinity.Type)

Indicates whether to consume capacity from an reservation or
not.

### [ResetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ResetInstanceRequest)

Request for resetting a notebook instance

### [ResetRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ResetRuntimeRequest)

Request for resetting a Managed Notebook Runtime.

### [RollbackInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RollbackInstanceRequest)

Request for rollbacking a notebook instance

### [Runtime](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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>

### [HealthState](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Runtime.HealthState)

The runtime substate.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Runtime.State)

The definition of the states of this runtime.

### [RuntimeAcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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`

### [AcceleratorType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeAcceleratorConfig.AcceleratorType)

Type of this accelerator.

### [RuntimeAccessConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeAccessConfig)

Specifies the login configuration for Runtime

### [RuntimeAccessType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeAccessConfig.RuntimeAccessType)

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

### [RuntimeMetrics](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeMetrics)

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

### [SystemMetricsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeMetrics.SystemMetricsEntry)

The abstract base class for a message.

### [RuntimeShieldedInstanceConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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`

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

### [PostStartupScriptBehavior](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.RuntimeSoftwareConfig.PostStartupScriptBehavior)

Behavior for the post startup script.

### [Schedule](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Schedule)

The definition of a schedule.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.Schedule.State)

State of the job.

### [SetInstanceAcceleratorRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.SetInstanceAcceleratorRequest)

Request for setting instance accelerator.

### [SetInstanceLabelsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.SetInstanceLabelsRequest)

Request for setting instance labels.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.SetInstanceLabelsRequest.LabelsEntry)

The abstract base class for a message.

### [SetInstanceMachineTypeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.SetInstanceMachineTypeRequest)

Request for setting instance machine type.

### [StartInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.StartInstanceRequest)

Request for starting a notebook instance

### [StartRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.StartRuntimeRequest)

Request for starting a Managed Notebook Runtime.

### [StopInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.StopInstanceRequest)

Request for stopping a notebook instance

### [StopRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.StopRuntimeRequest)

Request for stopping a Managed Notebook Runtime.

### [SwitchRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.SwitchRuntimeRequest)

Request for switching a Managed Notebook Runtime.

### [TriggerScheduleRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.TriggerScheduleRequest)

Request for created scheduled notebooks

### [UpdateInstanceConfigRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateInstanceConfigRequest)

Request for updating instance configurations.

### [UpdateInstanceMetadataItemsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsRequest)

Request for adding/changing metadata items for an instance.

### [ItemsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsRequest.ItemsEntry)

The abstract base class for a message.

### [UpdateInstanceMetadataItemsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsResponse)

Response for adding/changing metadata items for an instance.

### [ItemsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsResponse.ItemsEntry)

The abstract base class for a message.

### [UpdateRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateRuntimeRequest)

Request for updating a Managed Notebook configuration.

### [UpdateShieldedInstanceConfigRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpdateShieldedInstanceConfigRequest)

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

### [UpgradeInstanceInternalRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpgradeInstanceInternalRequest)

Request for upgrading a notebook instance from within the VM

### [UpgradeInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpgradeInstanceRequest)

Request for upgrading a notebook instance

### [UpgradeRuntimeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpgradeRuntimeRequest)

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

### [UpgradeType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.UpgradeType)

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

### [VirtualMachine](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachine)

Runtime using Virtual Machine for computing.

### [VirtualMachineConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig)

The config settings for virtual machine.

### [BootImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig.BootImage)

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

### [GuestAttributesEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig.GuestAttributesEntry)

The abstract base class for a message.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig.LabelsEntry)

The abstract base class for a message.

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig.MetadataEntry)

The abstract base class for a message.

### [NicType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VirtualMachineConfig.NicType)

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

### [VmImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.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>

### [NotebookServiceAsyncClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient)

API v1beta1 service for Cloud AI Platform Notebooks.

### [NotebookServiceClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient)

API v1beta1 service for Cloud AI Platform Notebooks.

### [ListEnvironmentsAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsAsyncPager)

A pager for iterating through `list_environments` requests.

This class thinly wraps an initial
[ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsResponse) object, and
provides an `__aiter__` method to iterate through its
`environments` field.

If there are more pages, the `__aiter__` method will make additional
`ListEnvironments` requests and continue to iterate
through the `environments` field on the
corresponding responses.

All the usual [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListEnvironmentsPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsPager)

A pager for iterating through `list_environments` requests.

This class thinly wraps an initial
[ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsResponse) object, and
provides an `__iter__` method to iterate through its
`environments` field.

If there are more pages, the `__iter__` method will make additional
`ListEnvironments` requests and continue to iterate
through the `environments` field on the
corresponding responses.

All the usual [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListInstancesAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesAsyncPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesResponse) object, and
provides an `__aiter__` method to iterate through its
`instances` field.

If there are more pages, the `__aiter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListInstancesPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesResponse) object, and
provides an `__iter__` method to iterate through its
`instances` field.

If there are more pages, the `__iter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ContainerImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ContainerImage)

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

### [CreateEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.CreateEnvironmentRequest)

Request for creating a notebook environment.

### [CreateInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.CreateInstanceRequest)

Request for creating a notebook instance.

### [DeleteEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.DeleteEnvironmentRequest)

Request for deleting a notebook environment.

### [DeleteInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.DeleteInstanceRequest)

Request for deleting a notebook instance.

### [Environment](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.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>

### [GetEnvironmentRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.GetEnvironmentRequest)

Request for getting a notebook environment.

### [GetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.GetInstanceRequest)

Request for getting a notebook instance.

### [Instance](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.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>

### [AcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.AcceleratorConfig)

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

### [AcceleratorType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.AcceleratorType)

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

### [DiskEncryption](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.DiskEncryption)

Definition of the disk encryption options.

### [DiskType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.DiskType)

Possible disk types for notebook instances.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.LabelsEntry)

The abstract base class for a message.

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.MetadataEntry)

The abstract base class for a message.

### [NicType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.NicType)

The type of vNIC driver.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.Instance.State)

The definition of the states of this instance.

### [IsInstanceUpgradeableRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.IsInstanceUpgradeableRequest)

Request for checking if a notebook instance is upgradeable.

### [IsInstanceUpgradeableResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.IsInstanceUpgradeableResponse)

Response for checking if a notebook instance is upgradeable.

### [ListEnvironmentsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsRequest)

Request for listing environments.

### [ListEnvironmentsResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListEnvironmentsResponse)

Response for listing environments.

### [ListInstancesRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesRequest)

Request for listing notebook instances.

### [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ListInstancesResponse)

Response for listing notebook instances.

### [OperationMetadata](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.OperationMetadata)

Represents the metadata of the long-running operation.

### [RegisterInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.RegisterInstanceRequest)

Request for registering a notebook instance.

### [ReportInstanceInfoRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ReportInstanceInfoRequest)

Request for notebook instances to report information to
Notebooks API.

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ReportInstanceInfoRequest.MetadataEntry)

The abstract base class for a message.

### [ReservationAffinity](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ReservationAffinity)

Reservation Affinity for consuming Zonal reservation.

### [Type](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ReservationAffinity.Type)

Indicates whether to consume capacity from an reservation or
not.

### [ResetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.ResetInstanceRequest)

Request for reseting a notebook instance

### [SetInstanceAcceleratorRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.SetInstanceAcceleratorRequest)

Request for setting instance accelerator.

### [SetInstanceLabelsRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.SetInstanceLabelsRequest)

Request for setting instance labels.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.SetInstanceLabelsRequest.LabelsEntry)

The abstract base class for a message.

### [SetInstanceMachineTypeRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.SetInstanceMachineTypeRequest)

Request for setting instance machine type.

### [StartInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.StartInstanceRequest)

Request for starting a notebook instance

### [StopInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.StopInstanceRequest)

Request for stopping a notebook instance

### [UpgradeInstanceInternalRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.UpgradeInstanceInternalRequest)

Request for upgrading a notebook instance from within the VM

### [UpgradeInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.UpgradeInstanceRequest)

Request for upgrading a notebook instance

### [VmImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.types.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>

### [NotebookServiceAsyncClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient)

API v2 service for Workbench Notebooks Instances.

### [NotebookServiceClient](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient)

API v2 service for Workbench Notebooks Instances.

### [ListInstancesAsyncPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesAsyncPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesResponse) object, and
provides an `__aiter__` method to iterate through its
`instances` field.

If there are more pages, the `__aiter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListInstancesPager](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesPager)

A pager for iterating through `list_instances` requests.

This class thinly wraps an initial
[ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesResponse) object, and
provides an `__iter__` method to iterate through its
`instances` field.

If there are more pages, the `__iter__` method will make additional
`ListInstances` requests and continue to iterate
through the `instances` field on the
corresponding responses.

All the usual [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [AcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.AcceleratorConfig)

An accelerator configuration for a VM instance Definition of a
hardware accelerator. Note that there is no check on `type` and
`core_count` combinations. TPUs are not supported. See `GPUs on
Compute
Engine <https://cloud.google.com/compute/docs/gpus/#gpus-list>`__ to
find a valid combination.

### [AcceleratorType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.AcceleratorConfig.AcceleratorType)

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

### [BootDisk](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.BootDisk)

The definition of a boot disk.

### [CheckInstanceUpgradabilityRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.CheckInstanceUpgradabilityRequest)

Request for checking if a notebook instance is upgradeable.

### [CheckInstanceUpgradabilityResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.CheckInstanceUpgradabilityResponse)

Response for checking if a notebook instance is upgradeable.

### [ContainerImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ContainerImage)

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

### [CreateInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.CreateInstanceRequest)

Request for creating a notebook instance.

### [DataDisk](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DataDisk)

An instance-attached disk resource.

### [DeleteInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DeleteInstanceRequest)

Request for deleting a notebook instance.

### [DiagnoseInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DiagnoseInstanceRequest)

Request for creating a notebook instance diagnostic file.

### [DiagnosticConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DiagnosticConfig)

Defines flags that are used to run the diagnostic tool

### [DiskEncryption](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DiskEncryption)

Definition of the disk encryption options.

### [DiskType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.DiskType)

Possible disk types.

### [Event](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Event)

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

### [DetailsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Event.DetailsEntry)

The abstract base class for a message.

### [EventType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Event.EventType)

The definition of the event types.

### [GPUDriverConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.GPUDriverConfig)

A GPU driver configuration

### [GceSetup](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.GceSetup)

The definition of how to configure a VM instance outside of
Resources and Identity.

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>

### [MetadataEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.GceSetup.MetadataEntry)

The abstract base class for a message.

### [GetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.GetInstanceRequest)

Request for getting a notebook instance.

### [HealthState](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.HealthState)

The instance health state.

### [Instance](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Instance)

The definition of a notebook instance.

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

### [HealthInfoEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Instance.HealthInfoEntry)

The abstract base class for a message.

### [LabelsEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.Instance.LabelsEntry)

The abstract base class for a message.

### [ListInstancesRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesRequest)

Request for listing notebook instances.

### [ListInstancesResponse](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ListInstancesResponse)

Response for listing notebook instances.

### [NetworkInterface](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.NetworkInterface)

The definition of a network interface resource attached to a
VM.

### [NicType](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.NetworkInterface.NicType)

The type of vNIC driver. Default should be NIC_TYPE_UNSPECIFIED.

### [OperationMetadata](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.OperationMetadata)

Represents the metadata of the long-running operation.

### [ResetInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ResetInstanceRequest)

Request for resetting a notebook instance

### [RollbackInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.RollbackInstanceRequest)

Request for rollbacking a notebook instance

### [ServiceAccount](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.ServiceAccount)

A service account that acts as an identity.

### [ShieldedInstanceConfig](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.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.

### [StartInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.StartInstanceRequest)

Request for starting a notebook instance

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.State)

The definition of the states of this instance.

### [StopInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.StopInstanceRequest)

Request for stopping a notebook instance

### [UpdateInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.UpdateInstanceRequest)

Request for updating a notebook instance.

### [UpgradeHistoryEntry](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.UpgradeHistoryEntry)

The entry of VM image upgrade history.

### [Action](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.UpgradeHistoryEntry.Action)

The definition of operations of this upgrade history entry.

### [State](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.UpgradeHistoryEntry.State)

The definition of the states of this upgrade history entry.

### [UpgradeInstanceRequest](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.UpgradeInstanceRequest)

Request for upgrading a notebook instance

### [VmImage](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.types.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>

## Modules

### [pagers](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.managed_notebook_service.pagers)

API documentation for `notebooks_v1.services.managed_notebook_service.pagers` module.

### [pagers](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.services.notebook_service.pagers)

API documentation for `notebooks_v1.services.notebook_service.pagers` module.

### [pagers](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1beta1.services.notebook_service.pagers)

API documentation for `notebooks_v1beta1.services.notebook_service.pagers` module.

### [pagers](https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v2.services.notebook_service.pagers)

API documentation for `notebooks_v2.services.notebook_service.pagers` module.