GoogleApi.Notebooks.V2.Model.Instance (google_api_notebooks v0.16.0)

View Source

The definition of a notebook instance.

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. Instance creation time.
  • creator (type: String.t, default: nil) - Output only. Email address of entity that sent original CreateInstance request.
  • disableProxyAccess (type: boolean(), default: nil) - Optional. If true, the notebook instance will not register with the proxy.
  • enableThirdPartyIdentity (type: boolean(), default: nil) - Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
  • gceSetup (type: GoogleApi.Notebooks.V2.Model.GceSetup.t, default: nil) - Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
  • healthInfo (type: map(), default: nil) - 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" }
  • healthState (type: String.t, default: nil) - Output only. Instance health_state.
  • id (type: String.t, default: nil) - Output only. Unique ID of the resource.
  • instanceOwners (type: list(String.t), default: nil) - 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.
  • labels (type: map(), default: nil) - Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
  • name (type: String.t, default: nil) - Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
  • proxyUri (type: String.t, default: nil) - Output only. The proxy endpoint that is used to access the Jupyter notebook.
  • satisfiesPzi (type: boolean(), default: nil) - Output only. Reserved for future use for Zone Isolation.
  • satisfiesPzs (type: boolean(), default: nil) - Output only. Reserved for future use for Zone Separation.
  • state (type: String.t, default: nil) - Output only. The state of this instance.
  • thirdPartyProxyUrl (type: String.t, default: nil) - Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.
  • updateTime (type: DateTime.t, default: nil) - Output only. Instance update time.
  • upgradeHistory (type: list(GoogleApi.Notebooks.V2.Model.UpgradeHistoryEntry.t), default: nil) - Output only. The upgrade history of this instance.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Notebooks.V2.Model.Instance{
  createTime: DateTime.t() | nil,
  creator: String.t() | nil,
  disableProxyAccess: boolean() | nil,
  enableThirdPartyIdentity: boolean() | nil,
  gceSetup: GoogleApi.Notebooks.V2.Model.GceSetup.t() | nil,
  healthInfo: map() | nil,
  healthState: String.t() | nil,
  id: String.t() | nil,
  instanceOwners: [String.t()] | nil,
  labels: map() | nil,
  name: String.t() | nil,
  proxyUri: String.t() | nil,
  satisfiesPzi: boolean() | nil,
  satisfiesPzs: boolean() | nil,
  state: String.t() | nil,
  thirdPartyProxyUrl: String.t() | nil,
  updateTime: DateTime.t() | nil,
  upgradeHistory: [GoogleApi.Notebooks.V2.Model.UpgradeHistoryEntry.t()] | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.