Notebooks v2 API - Class Instance (1.1.0)

public sealed class Instance : IMessage<Instance>, IEquatable<Instance>, IDeepCloneable<Instance>, IBufferMessage, IMessage

Reference documentation and code samples for the Notebooks v2 API class Instance.

The definition of a notebook instance.

Inheritance

object > Instance

Namespace

Google.Cloud.Notebooks.V2

Assembly

Google.Cloud.Notebooks.V2.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)
Parameter
Name Description
other Instance

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Instance creation time.

Property Value
Type Description
Timestamp

Creator

public string Creator { get; set; }

Output only. Email address of entity that sent original CreateInstance request.

Property Value
Type Description
string

DisableProxyAccess

public bool DisableProxyAccess { get; set; }

Optional. If true, the notebook instance will not register with the proxy.

Property Value
Type Description
bool

GceSetup

public GceSetup GceSetup { get; set; }

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

Property Value
Type Description
GceSetup

HealthInfo

public MapField<string, string> HealthInfo { get; }

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"
}
Property Value
Type Description
MapFieldstringstring

HealthState

public HealthState HealthState { get; set; }

Output only. Instance health_state.

Property Value
Type Description
HealthState

Id

public string Id { get; set; }

Output only. Unique ID of the resource.

Property Value
Type Description
string

InfrastructureCase

public Instance.InfrastructureOneofCase InfrastructureCase { get; }
Property Value
Type Description
InstanceInfrastructureOneofCase

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type Description
InstanceName

InstanceOwners

public RepeatedField<string> InstanceOwners { get; }

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

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.

Property Value
Type Description
RepeatedFieldstring

Labels

public MapField<string, string> Labels { get; }

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Property Value
Type Description
string

ProxyUri

public string ProxyUri { get; set; }

Output only. The proxy endpoint that is used to access the Jupyter notebook.

Property Value
Type Description
string

State

public State State { get; set; }

Output only. The state of this instance.

Property Value
Type Description
State

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Instance update time.

Property Value
Type Description
Timestamp

UpgradeHistory

public RepeatedField<UpgradeHistoryEntry> UpgradeHistory { get; }

Output only. The upgrade history of this instance.

Property Value
Type Description
RepeatedFieldUpgradeHistoryEntry