instances

Creates, updates, deletes, gets or lists a instances resource.

Overview

Name	`instances`
Type	Resource
Id	`google.notebooks.instances`

Fields

Name	Datatype	Description
`id`	`string`	Output only. Unique ID of the resource.
`name`	`string`	Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
`createTime`	`string`	Output only. Instance creation time.
`creator`	`string`	Output only. Email address of entity that sent original CreateInstance request.
`disableProxyAccess`	`boolean`	Optional. If true, the notebook instance will not register with the proxy.
`gceSetup`	`object`	The definition of how to configure a VM instance outside of Resources and Identity.
`healthInfo`	`object`	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`	`string`	Output only. Instance health_state.
`instanceOwners`	`array`	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`	`object`	Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
`proxyUri`	`string`	Output only. The proxy endpoint that is used to access the Jupyter notebook.
`satisfiesPzi`	`boolean`	Output only. Reserved for future use for Zone Isolation.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use for Zone Separation.
`state`	`string`	Output only. The state of this instance.
`thirdPartyProxyUrl`	`string`	Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.
`updateTime`	`string`	Output only. Instance update time.
`upgradeHistory`	`array`	Output only. The upgrade history of this instance.

Methods

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`instancesId, locationsId, projectsId`	Gets details of a single Instance.
`list`	`SELECT`	`locationsId, projectsId`	Lists instances in a given project and location.
`create`	`INSERT`	`locationsId, projectsId`	Creates a new Instance in a given project and location.
`delete`	`DELETE`	`instancesId, locationsId, projectsId`	Deletes a single Instance.
`patch`	`UPDATE`	`instancesId, locationsId, projectsId`	UpdateInstance updates an Instance.
`check_upgradability`	`EXEC`	`instancesId, locationsId, projectsId`	Checks whether a notebook instance is upgradable.
`diagnose`	`EXEC`	`instancesId, locationsId, projectsId`	Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`report_info_system`	`EXEC`	`instancesId, locationsId, projectsId`	Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
`reset`	`EXEC`	`instancesId, locationsId, projectsId`	Resets a notebook instance.
`resize_disk`	`EXEC`	`instancesId, locationsId, projectsId`	Resize a notebook instance disk to a higher capacity.
`restore`	`EXEC`	`instancesId, locationsId, projectsId`	RestoreInstance restores an Instance from a BackupSource.
`rollback`	`EXEC`	`instancesId, locationsId, projectsId`	Rollbacks a notebook instance to the previous version.
`start`	`EXEC`	`instancesId, locationsId, projectsId`	Starts a notebook instance.
`stop`	`EXEC`	`instancesId, locationsId, projectsId`	Stops a notebook instance.
`upgrade`	`EXEC`	`instancesId, locationsId, projectsId`	Upgrades a notebook instance to the latest version.
`upgrade_system`	`EXEC`	`instancesId, locationsId, projectsId`	Allows notebook instances to upgrade themselves. Do not use this method directly.

`SELECT` examples

Lists instances in a given project and location.

SELECT
id,
name,
createTime,
creator,
disableProxyAccess,
gceSetup,
healthInfo,
healthState,
instanceOwners,
labels,
proxyUri,
satisfiesPzi,
satisfiesPzs,
state,
thirdPartyProxyUrl,
updateTime,
upgradeHistory
FROM google.notebooks.instances
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new instances resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.notebooks.instances (
locationsId,
projectsId,
gceSetup,
instanceOwners,
disableProxyAccess,
labels
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ gceSetup }}',
'{{ instanceOwners }}',
{{ disableProxyAccess }},
'{{ labels }}'
;

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: gceSetup
      value:
        - name: machineType
          value: string
        - name: minCpuPlatform
          value: string
        - name: acceleratorConfigs
          value:
            - - name: type
                value: string
              - name: coreCount
                value: string
        - name: serviceAccounts
          value:
            - - name: email
                value: string
              - name: scopes
                value:
                  - string
        - name: vmImage
          value:
            - name: project
              value: string
            - name: name
              value: string
            - name: family
              value: string
        - name: containerImage
          value:
            - name: repository
              value: string
            - name: tag
              value: string
        - name: bootDisk
          value:
            - name: diskSizeGb
              value: string
            - name: diskType
              value: string
            - name: diskEncryption
              value: string
            - name: kmsKey
              value: string
        - name: dataDisks
          value:
            - - name: diskSizeGb
                value: string
              - name: diskType
                value: string
              - name: diskEncryption
                value: string
              - name: kmsKey
                value: string
        - name: shieldedInstanceConfig
          value:
            - name: enableSecureBoot
              value: boolean
            - name: enableVtpm
              value: boolean
            - name: enableIntegrityMonitoring
              value: boolean
        - name: networkInterfaces
          value:
            - - name: network
                value: string
              - name: subnet
                value: string
              - name: nicType
                value: string
              - name: accessConfigs
                value:
                  - - name: externalIp
                      value: string
        - name: disablePublicIp
          value: boolean
        - name: tags
          value:
            - string
        - name: metadata
          value: object
        - name: enableIpForwarding
          value: boolean
        - name: gpuDriverConfig
          value:
            - name: enableGpuDriver
              value: boolean
            - name: customGpuDriverPath
              value: string
    - name: proxyUri
      value: string
    - name: instanceOwners
      value:
        - string
    - name: creator
      value: string
    - name: state
      value: string
    - name: upgradeHistory
      value:
        - - name: snapshot
            value: string
          - name: vmImage
            value: string
          - name: containerImage
            value: string
          - name: framework
            value: string
          - name: version
            value: string
          - name: state
            value: string
          - name: createTime
            value: string
          - name: action
            value: string
          - name: targetVersion
            value: string
    - name: id
      value: string
    - name: healthState
      value: string
    - name: healthInfo
      value: object
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: disableProxyAccess
      value: boolean
    - name: labels
      value: object
    - name: thirdPartyProxyUrl
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: satisfiesPzi
      value: boolean

`UPDATE` example

Updates a instances resource.

/*+ update */
UPDATE google.notebooks.instances
SET 
gceSetup = '{{ gceSetup }}',
instanceOwners = '{{ instanceOwners }}',
disableProxyAccess = true|false,
labels = '{{ labels }}'
WHERE 
instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

`DELETE` example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM google.notebooks.instances
WHERE instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​