Class Instance (1.8.0)

Version 1.8.0

• 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

Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The definition of a notebook instance.

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

Attributes
Name	Description
name	str Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
gce_setup	google.cloud.notebooks_v2.types.GceSetup Optional. Compute Engine setup for the notebook. Uses notebook-defined fields. This field is a member of oneof_ infrastructure.
proxy_uri	str Output only. The proxy endpoint that is used to access the Jupyter notebook.
instance_owners	MutableSequence[str] Optional. Input only. The owner of this instance after creation. Format: [e-mail] Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
creator	str Output only. Email address of entity that sent original CreateInstance request.
state	google.cloud.notebooks_v2.types.State Output only. The state of this instance.
upgrade_history	MutableSequence[google.cloud.notebooks_v2.types.UpgradeHistoryEntry] Output only. The upgrade history of this instance.
id	str Output only. Unique ID of the resource.
health_state	google.cloud.notebooks_v2.types.HealthState Output only. Instance health_state.
health_info	MutableMapping[str, str] Output only. Additional information about instance health. Example: :: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Instance creation time.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Instance update time.
disable_proxy_access	bool Optional. If true, the notebook instance will not register with the proxy.
labels	MutableMapping[str, str] Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

Classes

HealthInfoEntry

HealthInfoEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.