Class Instance

The definition of a notebook instance.

Inheritance
object
Instance
Implements
Inherited Members
Namespace: Google.Apis.AIPlatformNotebooks.v2.Data
Assembly: Google.Apis.AIPlatformNotebooks.v2.dll
Syntax
public class Instance : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Instance creation time.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Creator

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

Declaration
[JsonProperty("creator")]
public virtual string Creator { get; set; }
Property Value
Type Description
string

DisableProxyAccess

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

Declaration
[JsonProperty("disableProxyAccess")]
public virtual bool? DisableProxyAccess { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableDeletionProtection

Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.

Declaration
[JsonProperty("enableDeletionProtection")]
public virtual bool? EnableDeletionProtection { get; set; }
Property Value
Type Description
bool?

EnableThirdPartyIdentity

Optional. Flag that specifies that a notebook can be accessed with third party identity provider.

Declaration
[JsonProperty("enableThirdPartyIdentity")]
public virtual bool? EnableThirdPartyIdentity { get; set; }
Property Value
Type Description
bool?

GceSetup

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

Declaration
[JsonProperty("gceSetup")]
public virtual GceSetup GceSetup { get; set; }
Property Value
Type Description
GceSetup

HealthInfo

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" }

Declaration
[JsonProperty("healthInfo")]
public virtual IDictionary<string, string> HealthInfo { get; set; }
Property Value
Type Description
IDictionary<string, string>

HealthState

Output only. Instance health_state.

Declaration
[JsonProperty("healthState")]
public virtual string HealthState { get; set; }
Property Value
Type Description
string

Id

Output only. Unique ID of the resource.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

InstanceOwners

Optional. 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.

Declaration
[JsonProperty("instanceOwners")]
public virtual IList<string> InstanceOwners { get; set; }
Property Value
Type Description
IList<string>

Labels

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

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ProxyUri

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

Declaration
[JsonProperty("proxyUri")]
public virtual string ProxyUri { get; set; }
Property Value
Type Description
string

SatisfiesPzi

Output only. Reserved for future use for Zone Isolation.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use for Zone Separation.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

State

Output only. The state of this instance.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

ThirdPartyProxyUrl

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

Declaration
[JsonProperty("thirdPartyProxyUrl")]
public virtual string ThirdPartyProxyUrl { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Instance update time.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UpgradeHistory

Output only. The upgrade history of this instance.

Declaration
[JsonProperty("upgradeHistory")]
public virtual IList<UpgradeHistoryEntry> UpgradeHistory { get; set; }
Property Value
Type Description
IList<UpgradeHistoryEntry>

Implements