Package types (0.4.3)

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

API documentation for notebooks_v1beta1.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

CreateInstanceRequest

Request for creating a notebook instance. .. 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

DeleteInstanceRequest

Request for deleting a notebook instance. .. attribute:: name

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

:type: str

Environment

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

GetEnvironmentRequest

Request for getting a notebook environment. .. attribute:: name

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

:type: str

GetInstanceRequest

Request for getting a notebook instance. .. attribute:: name

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

:type: str

Instance

The definition of a notebook instance.

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_v1beta1.types.Environment]

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_v1beta1.types.Instance]

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.

ResetInstanceRequest

Request for reseting a notebook instance .. attribute:: name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_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

StopInstanceRequest

Request for stopping a notebook instance .. attribute:: name

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

:type: str

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

VmImage

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