1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="notebooks_v1.html">Notebooks API</a> . <a href="notebooks_v1.projects.html">projects</a> . <a href="notebooks_v1.projects.locations.html">locations</a> . <a href="notebooks_v1.projects.locations.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new Instance in a given project and location.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a single Instance.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets details of a single Instance.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 92<p class="toc_element"> 93 <code><a href="#getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Check if a notebook instance is healthy.</p> 95<p class="toc_element"> 96 <code><a href="#isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</a></code></p> 97<p class="firstline">Check if a notebook instance is upgradable.</p> 98<p class="toc_element"> 99 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists instances in a given project and location.</p> 101<p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#register">register(parent, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.</p> 107<p class="toc_element"> 108 <code><a href="#report">report(name, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">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.</p> 110<p class="toc_element"> 111 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Resets a notebook instance.</p> 113<p class="toc_element"> 114 <code><a href="#rollback">rollback(name, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Rollbacks a notebook instance to the previous version.</p> 116<p class="toc_element"> 117 <code><a href="#setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Updates the guest accelerators of a single Instance.</p> 119<p class="toc_element"> 120 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p> 122<p class="toc_element"> 123 <code><a href="#setLabels">setLabels(name, body=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Replaces all the labels of an Instance.</p> 125<p class="toc_element"> 126 <code><a href="#setMachineType">setMachineType(name, body=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Updates the machine type of a single Instance.</p> 128<p class="toc_element"> 129 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> 130<p class="firstline">Starts a notebook instance.</p> 131<p class="toc_element"> 132 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> 133<p class="firstline">Stops a notebook instance.</p> 134<p class="toc_element"> 135 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 136<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p> 137<p class="toc_element"> 138 <code><a href="#updateConfig">updateConfig(name, body=None, x__xgafv=None)</a></code></p> 139<p class="firstline">Update Notebook Instance configurations.</p> 140<p class="toc_element"> 141 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</a></code></p> 142<p class="firstline">Updates the Shielded instance configuration of a single Instance.</p> 143<p class="toc_element"> 144 <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p> 145<p class="firstline">Upgrades a notebook instance to the latest version.</p> 146<p class="toc_element"> 147 <code><a href="#upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</a></code></p> 148<p class="firstline">Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.</p> 149<h3>Method Details</h3> 150<div class="method"> 151 <code class="details" id="close">close()</code> 152 <pre>Close httplib2 connections.</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code> 157 <pre>Creates a new Instance in a given project and location. 158 159Args: 160 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required) 161 body: object, The request body. 162 The object takes the form of: 163 164{ # The definition of a notebook instance. 165 "acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported. # The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](/compute/docs/gpus/#gpus-list). 166 "coreCount": "A String", # Count of cores of this accelerator. 167 "type": "A String", # Type of this accelerator. 168 }, 169 "bootDiskSizeGb": "A String", # Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. 170 "bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 171 "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance. 172 "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}` 173 "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag. 174 }, 175 "createTime": "A String", # Output only. Instance creation time. 176 "customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. 177 "dataDiskSizeGb": "A String", # Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. 178 "dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 179 "diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. 180 "disks": [ # Output only. Attached disks to notebook instance. 181 { # An instance-attached disk resource. 182 "autoDelete": True or False, # Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). 183 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. 184 "deviceName": "A String", # Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks. 185 "diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB. 186 "guestOsFeatures": [ # Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. 187 { # Guest OS features for boot disk. 188 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS 189 }, 190 ], 191 "index": "A String", # A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. 192 "interface": "A String", # Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI 193 "kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks. 194 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images. 195 "A String", 196 ], 197 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE 198 "source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource. 199 "type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH 200 }, 201 ], 202 "installGpuDriver": True or False, # Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. 203 "instanceOwners": [ # Input only. The owner of this instance after creation. Format: `[email protected]` 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. 204 "A String", 205 ], 206 "kmsKey": "A String", # Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about [using your own encryption keys](/kms/docs/quickstart). 207 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 208 "a_key": "A String", 209 }, 210 "machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance. 211 "metadata": { # Custom metadata to apply to this instance. 212 "a_key": "A String", 213 }, 214 "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` 215 "network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}` 216 "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 217 "noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy. 218 "noPublicIp": True or False, # If true, no public IP will be assigned to this instance. 219 "noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance. 220 "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (`gs://path-to-file/file-name`). 221 "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. 222 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance. 223 "consumeReservationType": "A String", # Optional. Type of reservation to consume 224 "key": "A String", # Optional. Corresponds to the label key of reservation resource. 225 "values": [ # Optional. Corresponds to the label values of reservation resource. 226 "A String", 227 ], 228 }, 229 "serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. 230 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute 231 "A String", 232 ], 233 "shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). 234 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default. 235 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default. 236 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 237 }, 238 "state": "A String", # Output only. The state of this instance. 239 "subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` 240 "tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). 241 "A String", 242 ], 243 "updateTime": "A String", # Output only. Instance update time. 244 "upgradeHistory": [ # The upgrade history of this instance. 245 { # The entry of VM image upgrade history. 246 "action": "A String", # Action. Rolloback or Upgrade. 247 "containerImage": "A String", # The container image before this instance upgrade. 248 "createTime": "A String", # The time that this instance upgrade history entry is created. 249 "framework": "A String", # The framework of this notebook instance. 250 "snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade. 251 "state": "A String", # The state of this instance upgrade history entry. 252 "targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name. 253 "targetVersion": "A String", # Target VM Version, like m63. 254 "version": "A String", # The version of the notebook instance before this upgrade. 255 "vmImage": "A String", # The VM image before this instance upgrade. 256 }, 257 ], 258 "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance. 259 "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used. 260 "imageName": "A String", # Use VM image name to find the image. 261 "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}` 262 }, 263} 264 265 instanceId: string, Required. User-defined unique ID of this instance. 266 x__xgafv: string, V1 error format. 267 Allowed values 268 1 - v1 error format 269 2 - v2 error format 270 271Returns: 272 An object of the form: 273 274 { # This resource represents a long-running operation that is the result of a network API call. 275 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 276 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 277 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 278 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 279 { 280 "a_key": "", # Properties of the object. Contains field @type with type URL. 281 }, 282 ], 283 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 284 }, 285 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 286 "a_key": "", # Properties of the object. Contains field @type with type URL. 287 }, 288 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 289 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 290 "a_key": "", # Properties of the object. Contains field @type with type URL. 291 }, 292}</pre> 293</div> 294 295<div class="method"> 296 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 297 <pre>Deletes a single Instance. 298 299Args: 300 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 301 x__xgafv: string, V1 error format. 302 Allowed values 303 1 - v1 error format 304 2 - v2 error format 305 306Returns: 307 An object of the form: 308 309 { # This resource represents a long-running operation that is the result of a network API call. 310 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 311 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 312 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 313 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 314 { 315 "a_key": "", # Properties of the object. Contains field @type with type URL. 316 }, 317 ], 318 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 319 }, 320 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 321 "a_key": "", # Properties of the object. Contains field @type with type URL. 322 }, 323 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 324 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 325 "a_key": "", # Properties of the object. Contains field @type with type URL. 326 }, 327}</pre> 328</div> 329 330<div class="method"> 331 <code class="details" id="get">get(name, x__xgafv=None)</code> 332 <pre>Gets details of a single Instance. 333 334Args: 335 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 336 x__xgafv: string, V1 error format. 337 Allowed values 338 1 - v1 error format 339 2 - v2 error format 340 341Returns: 342 An object of the form: 343 344 { # The definition of a notebook instance. 345 "acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported. # The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](/compute/docs/gpus/#gpus-list). 346 "coreCount": "A String", # Count of cores of this accelerator. 347 "type": "A String", # Type of this accelerator. 348 }, 349 "bootDiskSizeGb": "A String", # Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. 350 "bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 351 "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance. 352 "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}` 353 "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag. 354 }, 355 "createTime": "A String", # Output only. Instance creation time. 356 "customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. 357 "dataDiskSizeGb": "A String", # Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. 358 "dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 359 "diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. 360 "disks": [ # Output only. Attached disks to notebook instance. 361 { # An instance-attached disk resource. 362 "autoDelete": True or False, # Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). 363 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. 364 "deviceName": "A String", # Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks. 365 "diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB. 366 "guestOsFeatures": [ # Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. 367 { # Guest OS features for boot disk. 368 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS 369 }, 370 ], 371 "index": "A String", # A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. 372 "interface": "A String", # Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI 373 "kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks. 374 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images. 375 "A String", 376 ], 377 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE 378 "source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource. 379 "type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH 380 }, 381 ], 382 "installGpuDriver": True or False, # Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. 383 "instanceOwners": [ # Input only. The owner of this instance after creation. Format: `[email protected]` 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. 384 "A String", 385 ], 386 "kmsKey": "A String", # Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about [using your own encryption keys](/kms/docs/quickstart). 387 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 388 "a_key": "A String", 389 }, 390 "machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance. 391 "metadata": { # Custom metadata to apply to this instance. 392 "a_key": "A String", 393 }, 394 "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` 395 "network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}` 396 "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 397 "noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy. 398 "noPublicIp": True or False, # If true, no public IP will be assigned to this instance. 399 "noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance. 400 "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (`gs://path-to-file/file-name`). 401 "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. 402 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance. 403 "consumeReservationType": "A String", # Optional. Type of reservation to consume 404 "key": "A String", # Optional. Corresponds to the label key of reservation resource. 405 "values": [ # Optional. Corresponds to the label values of reservation resource. 406 "A String", 407 ], 408 }, 409 "serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. 410 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute 411 "A String", 412 ], 413 "shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). 414 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default. 415 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default. 416 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 417 }, 418 "state": "A String", # Output only. The state of this instance. 419 "subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` 420 "tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). 421 "A String", 422 ], 423 "updateTime": "A String", # Output only. Instance update time. 424 "upgradeHistory": [ # The upgrade history of this instance. 425 { # The entry of VM image upgrade history. 426 "action": "A String", # Action. Rolloback or Upgrade. 427 "containerImage": "A String", # The container image before this instance upgrade. 428 "createTime": "A String", # The time that this instance upgrade history entry is created. 429 "framework": "A String", # The framework of this notebook instance. 430 "snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade. 431 "state": "A String", # The state of this instance upgrade history entry. 432 "targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name. 433 "targetVersion": "A String", # Target VM Version, like m63. 434 "version": "A String", # The version of the notebook instance before this upgrade. 435 "vmImage": "A String", # The VM image before this instance upgrade. 436 }, 437 ], 438 "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance. 439 "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used. 440 "imageName": "A String", # Use VM image name to find the image. 441 "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}` 442 }, 443}</pre> 444</div> 445 446<div class="method"> 447 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 448 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 449 450Args: 451 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 452 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 453 x__xgafv: string, V1 error format. 454 Allowed values 455 1 - v1 error format 456 2 - v2 error format 457 458Returns: 459 An object of the form: 460 461 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 462 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 463 { # Associates `members`, or principals, with a `role`. 464 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 465 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 466 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 467 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 468 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 469 }, 470 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 471 "A String", 472 ], 473 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 474 }, 475 ], 476 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 477 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 478}</pre> 479</div> 480 481<div class="method"> 482 <code class="details" id="getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</code> 483 <pre>Check if a notebook instance is healthy. 484 485Args: 486 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 487 x__xgafv: string, V1 error format. 488 Allowed values 489 1 - v1 error format 490 2 - v2 error format 491 492Returns: 493 An object of the form: 494 495 { # Response for checking if a notebook instance is healthy. 496 "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" } 497 "a_key": "A String", 498 }, 499 "healthState": "A String", # Output only. Runtime health_state. 500}</pre> 501</div> 502 503<div class="method"> 504 <code class="details" id="isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</code> 505 <pre>Check if a notebook instance is upgradable. 506 507Args: 508 notebookInstance: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 509 x__xgafv: string, V1 error format. 510 Allowed values 511 1 - v1 error format 512 2 - v2 error format 513 514Returns: 515 An object of the form: 516 517 { # Response for checking if a notebook instance is upgradeable. 518 "upgradeImage": "A String", # The new image self link this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true. 519 "upgradeInfo": "A String", # Additional information about upgrade. 520 "upgradeVersion": "A String", # The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true. 521 "upgradeable": True or False, # If an instance is upgradeable. 522}</pre> 523</div> 524 525<div class="method"> 526 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 527 <pre>Lists instances in a given project and location. 528 529Args: 530 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required) 531 pageSize: integer, Maximum return size of the list call. 532 pageToken: string, A previous returned page token that can be used to continue listing from the last result. 533 x__xgafv: string, V1 error format. 534 Allowed values 535 1 - v1 error format 536 2 - v2 error format 537 538Returns: 539 An object of the form: 540 541 { # Response for listing notebook instances. 542 "instances": [ # A list of returned instances. 543 { # The definition of a notebook instance. 544 "acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported. # The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](/compute/docs/gpus/#gpus-list). 545 "coreCount": "A String", # Count of cores of this accelerator. 546 "type": "A String", # Type of this accelerator. 547 }, 548 "bootDiskSizeGb": "A String", # Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. 549 "bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 550 "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance. 551 "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}` 552 "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag. 553 }, 554 "createTime": "A String", # Output only. Instance creation time. 555 "customGpuDriverPath": "A String", # Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. 556 "dataDiskSizeGb": "A String", # Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. 557 "dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). 558 "diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. 559 "disks": [ # Output only. Attached disks to notebook instance. 560 { # An instance-attached disk resource. 561 "autoDelete": True or False, # Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). 562 "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. 563 "deviceName": "A String", # Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks. 564 "diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB. 565 "guestOsFeatures": [ # Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. 566 { # Guest OS features for boot disk. 567 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS 568 }, 569 ], 570 "index": "A String", # A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. 571 "interface": "A String", # Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI 572 "kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks. 573 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images. 574 "A String", 575 ], 576 "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE 577 "source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource. 578 "type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH 579 }, 580 ], 581 "installGpuDriver": True or False, # Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. 582 "instanceOwners": [ # Input only. The owner of this instance after creation. Format: `[email protected]` 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. 583 "A String", 584 ], 585 "kmsKey": "A String", # Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about [using your own encryption keys](/kms/docs/quickstart). 586 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 587 "a_key": "A String", 588 }, 589 "machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance. 590 "metadata": { # Custom metadata to apply to this instance. 591 "a_key": "A String", 592 }, 593 "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` 594 "network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}` 595 "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 596 "noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy. 597 "noPublicIp": True or False, # If true, no public IP will be assigned to this instance. 598 "noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance. 599 "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (`gs://path-to-file/file-name`). 600 "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. 601 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance. 602 "consumeReservationType": "A String", # Optional. Type of reservation to consume 603 "key": "A String", # Optional. Corresponds to the label key of reservation resource. 604 "values": [ # Optional. Corresponds to the label values of reservation resource. 605 "A String", 606 ], 607 }, 608 "serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. 609 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute 610 "A String", 611 ], 612 "shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). 613 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default. 614 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default. 615 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 616 }, 617 "state": "A String", # Output only. The state of this instance. 618 "subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` 619 "tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). 620 "A String", 621 ], 622 "updateTime": "A String", # Output only. Instance update time. 623 "upgradeHistory": [ # The upgrade history of this instance. 624 { # The entry of VM image upgrade history. 625 "action": "A String", # Action. Rolloback or Upgrade. 626 "containerImage": "A String", # The container image before this instance upgrade. 627 "createTime": "A String", # The time that this instance upgrade history entry is created. 628 "framework": "A String", # The framework of this notebook instance. 629 "snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade. 630 "state": "A String", # The state of this instance upgrade history entry. 631 "targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name. 632 "targetVersion": "A String", # Target VM Version, like m63. 633 "version": "A String", # The version of the notebook instance before this upgrade. 634 "vmImage": "A String", # The VM image before this instance upgrade. 635 }, 636 ], 637 "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance. 638 "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used. 639 "imageName": "A String", # Use VM image name to find the image. 640 "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}` 641 }, 642 }, 643 ], 644 "nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call. 645 "unreachable": [ # Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables, 646 "A String", 647 ], 648}</pre> 649</div> 650 651<div class="method"> 652 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 653 <pre>Retrieves the next page of results. 654 655Args: 656 previous_request: The request for the previous page. (required) 657 previous_response: The response from the request for the previous page. (required) 658 659Returns: 660 A request object that you can call 'execute()' on to request the next 661 page. Returns None if there are no more items in the collection. 662 </pre> 663</div> 664 665<div class="method"> 666 <code class="details" id="register">register(parent, body=None, x__xgafv=None)</code> 667 <pre>Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API. 668 669Args: 670 parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required) 671 body: object, The request body. 672 The object takes the form of: 673 674{ # Request for registering a notebook instance. 675 "instanceId": "A String", # Required. User defined unique ID of this instance. The `instance_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash. 676} 677 678 x__xgafv: string, V1 error format. 679 Allowed values 680 1 - v1 error format 681 2 - v2 error format 682 683Returns: 684 An object of the form: 685 686 { # This resource represents a long-running operation that is the result of a network API call. 687 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 688 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 689 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 690 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 691 { 692 "a_key": "", # Properties of the object. Contains field @type with type URL. 693 }, 694 ], 695 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 696 }, 697 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 698 "a_key": "", # Properties of the object. Contains field @type with type URL. 699 }, 700 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 701 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 702 "a_key": "", # Properties of the object. Contains field @type with type URL. 703 }, 704}</pre> 705</div> 706 707<div class="method"> 708 <code class="details" id="report">report(name, body=None, x__xgafv=None)</code> 709 <pre>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. 710 711Args: 712 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 713 body: object, The request body. 714 The object takes the form of: 715 716{ # Request for notebook instances to report information to Notebooks API. 717 "metadata": { # The metadata reported to Notebooks API. This will be merged to the instance metadata store 718 "a_key": "A String", 719 }, 720 "vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity 721} 722 723 x__xgafv: string, V1 error format. 724 Allowed values 725 1 - v1 error format 726 2 - v2 error format 727 728Returns: 729 An object of the form: 730 731 { # This resource represents a long-running operation that is the result of a network API call. 732 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 733 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 734 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 735 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 736 { 737 "a_key": "", # Properties of the object. Contains field @type with type URL. 738 }, 739 ], 740 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 741 }, 742 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 743 "a_key": "", # Properties of the object. Contains field @type with type URL. 744 }, 745 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 746 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 747 "a_key": "", # Properties of the object. Contains field @type with type URL. 748 }, 749}</pre> 750</div> 751 752<div class="method"> 753 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code> 754 <pre>Resets a notebook instance. 755 756Args: 757 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 758 body: object, The request body. 759 The object takes the form of: 760 761{ # Request for reseting a notebook instance 762} 763 764 x__xgafv: string, V1 error format. 765 Allowed values 766 1 - v1 error format 767 2 - v2 error format 768 769Returns: 770 An object of the form: 771 772 { # This resource represents a long-running operation that is the result of a network API call. 773 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 774 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 775 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 776 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 777 { 778 "a_key": "", # Properties of the object. Contains field @type with type URL. 779 }, 780 ], 781 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 782 }, 783 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 784 "a_key": "", # Properties of the object. Contains field @type with type URL. 785 }, 786 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 787 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 788 "a_key": "", # Properties of the object. Contains field @type with type URL. 789 }, 790}</pre> 791</div> 792 793<div class="method"> 794 <code class="details" id="rollback">rollback(name, body=None, x__xgafv=None)</code> 795 <pre>Rollbacks a notebook instance to the previous version. 796 797Args: 798 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 799 body: object, The request body. 800 The object takes the form of: 801 802{ # Request for rollbacking a notebook instance 803 "targetSnapshot": "A String", # Required. The snapshot for rollback. Example: "projects/test-project/global/snapshots/krwlzipynril". 804} 805 806 x__xgafv: string, V1 error format. 807 Allowed values 808 1 - v1 error format 809 2 - v2 error format 810 811Returns: 812 An object of the form: 813 814 { # This resource represents a long-running operation that is the result of a network API call. 815 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 816 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 817 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 818 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 819 { 820 "a_key": "", # Properties of the object. Contains field @type with type URL. 821 }, 822 ], 823 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 824 }, 825 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 826 "a_key": "", # Properties of the object. Contains field @type with type URL. 827 }, 828 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 829 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 830 "a_key": "", # Properties of the object. Contains field @type with type URL. 831 }, 832}</pre> 833</div> 834 835<div class="method"> 836 <code class="details" id="setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</code> 837 <pre>Updates the guest accelerators of a single Instance. 838 839Args: 840 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 841 body: object, The request body. 842 The object takes the form of: 843 844{ # Request for setting instance accelerator. 845 "coreCount": "A String", # Required. Count of cores of this accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported. 846 "type": "A String", # Required. Type of this accelerator. 847} 848 849 x__xgafv: string, V1 error format. 850 Allowed values 851 1 - v1 error format 852 2 - v2 error format 853 854Returns: 855 An object of the form: 856 857 { # This resource represents a long-running operation that is the result of a network API call. 858 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 859 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 860 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 861 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 862 { 863 "a_key": "", # Properties of the object. Contains field @type with type URL. 864 }, 865 ], 866 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 867 }, 868 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 869 "a_key": "", # Properties of the object. Contains field @type with type URL. 870 }, 871 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 872 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 873 "a_key": "", # Properties of the object. Contains field @type with type URL. 874 }, 875}</pre> 876</div> 877 878<div class="method"> 879 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 880 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. 881 882Args: 883 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 884 body: object, The request body. 885 The object takes the form of: 886 887{ # Request message for `SetIamPolicy` method. 888 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. 889 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 890 { # Associates `members`, or principals, with a `role`. 891 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 892 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 893 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 894 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 895 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 896 }, 897 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 898 "A String", 899 ], 900 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 901 }, 902 ], 903 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 904 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 905 }, 906} 907 908 x__xgafv: string, V1 error format. 909 Allowed values 910 1 - v1 error format 911 2 - v2 error format 912 913Returns: 914 An object of the form: 915 916 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 917 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 918 { # Associates `members`, or principals, with a `role`. 919 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 920 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 921 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 922 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 923 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 924 }, 925 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 926 "A String", 927 ], 928 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 929 }, 930 ], 931 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 932 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 933}</pre> 934</div> 935 936<div class="method"> 937 <code class="details" id="setLabels">setLabels(name, body=None, x__xgafv=None)</code> 938 <pre>Replaces all the labels of an Instance. 939 940Args: 941 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 942 body: object, The request body. 943 The object takes the form of: 944 945{ # Request for setting instance labels. 946 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method 947 "a_key": "A String", 948 }, 949} 950 951 x__xgafv: string, V1 error format. 952 Allowed values 953 1 - v1 error format 954 2 - v2 error format 955 956Returns: 957 An object of the form: 958 959 { # This resource represents a long-running operation that is the result of a network API call. 960 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 961 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 962 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 963 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 964 { 965 "a_key": "", # Properties of the object. Contains field @type with type URL. 966 }, 967 ], 968 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 969 }, 970 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 971 "a_key": "", # Properties of the object. Contains field @type with type URL. 972 }, 973 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 974 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 975 "a_key": "", # Properties of the object. Contains field @type with type URL. 976 }, 977}</pre> 978</div> 979 980<div class="method"> 981 <code class="details" id="setMachineType">setMachineType(name, body=None, x__xgafv=None)</code> 982 <pre>Updates the machine type of a single Instance. 983 984Args: 985 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 986 body: object, The request body. 987 The object takes the form of: 988 989{ # Request for setting instance machine type. 990 "machineType": "A String", # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types). 991} 992 993 x__xgafv: string, V1 error format. 994 Allowed values 995 1 - v1 error format 996 2 - v2 error format 997 998Returns: 999 An object of the form: 1000 1001 { # This resource represents a long-running operation that is the result of a network API call. 1002 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1003 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1004 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1005 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1006 { 1007 "a_key": "", # Properties of the object. Contains field @type with type URL. 1008 }, 1009 ], 1010 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1011 }, 1012 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1013 "a_key": "", # Properties of the object. Contains field @type with type URL. 1014 }, 1015 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1016 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1017 "a_key": "", # Properties of the object. Contains field @type with type URL. 1018 }, 1019}</pre> 1020</div> 1021 1022<div class="method"> 1023 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> 1024 <pre>Starts a notebook instance. 1025 1026Args: 1027 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1028 body: object, The request body. 1029 The object takes the form of: 1030 1031{ # Request for starting a notebook instance 1032} 1033 1034 x__xgafv: string, V1 error format. 1035 Allowed values 1036 1 - v1 error format 1037 2 - v2 error format 1038 1039Returns: 1040 An object of the form: 1041 1042 { # This resource represents a long-running operation that is the result of a network API call. 1043 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1044 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1045 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1046 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1047 { 1048 "a_key": "", # Properties of the object. Contains field @type with type URL. 1049 }, 1050 ], 1051 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1052 }, 1053 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1054 "a_key": "", # Properties of the object. Contains field @type with type URL. 1055 }, 1056 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1057 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1058 "a_key": "", # Properties of the object. Contains field @type with type URL. 1059 }, 1060}</pre> 1061</div> 1062 1063<div class="method"> 1064 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 1065 <pre>Stops a notebook instance. 1066 1067Args: 1068 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1069 body: object, The request body. 1070 The object takes the form of: 1071 1072{ # Request for stopping a notebook instance 1073} 1074 1075 x__xgafv: string, V1 error format. 1076 Allowed values 1077 1 - v1 error format 1078 2 - v2 error format 1079 1080Returns: 1081 An object of the form: 1082 1083 { # This resource represents a long-running operation that is the result of a network API call. 1084 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1085 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1086 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1087 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1088 { 1089 "a_key": "", # Properties of the object. Contains field @type with type URL. 1090 }, 1091 ], 1092 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1093 }, 1094 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1095 "a_key": "", # Properties of the object. Contains field @type with type URL. 1096 }, 1097 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1098 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1099 "a_key": "", # Properties of the object. Contains field @type with type URL. 1100 }, 1101}</pre> 1102</div> 1103 1104<div class="method"> 1105 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 1106 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. 1107 1108Args: 1109 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 1110 body: object, The request body. 1111 The object takes the form of: 1112 1113{ # Request message for `TestIamPermissions` method. 1114 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1115 "A String", 1116 ], 1117} 1118 1119 x__xgafv: string, V1 error format. 1120 Allowed values 1121 1 - v1 error format 1122 2 - v2 error format 1123 1124Returns: 1125 An object of the form: 1126 1127 { # Response message for `TestIamPermissions` method. 1128 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1129 "A String", 1130 ], 1131}</pre> 1132</div> 1133 1134<div class="method"> 1135 <code class="details" id="updateConfig">updateConfig(name, body=None, x__xgafv=None)</code> 1136 <pre>Update Notebook Instance configurations. 1137 1138Args: 1139 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1140 body: object, The request body. 1141 The object takes the form of: 1142 1143{ # Request for updating instance configurations. 1144 "config": { # Notebook instance configurations that can be updated. # The instance configurations to be updated. 1145 "enableHealthMonitoring": True or False, # Verifies core internal services are running. 1146 "notebookUpgradeSchedule": "A String", # Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron). 1147 }, 1148} 1149 1150 x__xgafv: string, V1 error format. 1151 Allowed values 1152 1 - v1 error format 1153 2 - v2 error format 1154 1155Returns: 1156 An object of the form: 1157 1158 { # This resource represents a long-running operation that is the result of a network API call. 1159 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1160 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1161 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1162 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1163 { 1164 "a_key": "", # Properties of the object. Contains field @type with type URL. 1165 }, 1166 ], 1167 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1168 }, 1169 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1170 "a_key": "", # Properties of the object. Contains field @type with type URL. 1171 }, 1172 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1173 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1174 "a_key": "", # Properties of the object. Contains field @type with type URL. 1175 }, 1176}</pre> 1177</div> 1178 1179<div class="method"> 1180 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</code> 1181 <pre>Updates the Shielded instance configuration of a single Instance. 1182 1183Args: 1184 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1185 body: object, The request body. 1186 The object takes the form of: 1187 1188{ # Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance 1189 "shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # ShieldedInstance configuration to be updated. 1190 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default. 1191 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default. 1192 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 1193 }, 1194} 1195 1196 x__xgafv: string, V1 error format. 1197 Allowed values 1198 1 - v1 error format 1199 2 - v2 error format 1200 1201Returns: 1202 An object of the form: 1203 1204 { # This resource represents a long-running operation that is the result of a network API call. 1205 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1206 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1207 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1208 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1209 { 1210 "a_key": "", # Properties of the object. Contains field @type with type URL. 1211 }, 1212 ], 1213 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1214 }, 1215 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1216 "a_key": "", # Properties of the object. Contains field @type with type URL. 1217 }, 1218 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1219 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1220 "a_key": "", # Properties of the object. Contains field @type with type URL. 1221 }, 1222}</pre> 1223</div> 1224 1225<div class="method"> 1226 <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code> 1227 <pre>Upgrades a notebook instance to the latest version. 1228 1229Args: 1230 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1231 body: object, The request body. 1232 The object takes the form of: 1233 1234{ # Request for upgrading a notebook instance 1235} 1236 1237 x__xgafv: string, V1 error format. 1238 Allowed values 1239 1 - v1 error format 1240 2 - v2 error format 1241 1242Returns: 1243 An object of the form: 1244 1245 { # This resource represents a long-running operation that is the result of a network API call. 1246 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1247 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1248 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1249 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1250 { 1251 "a_key": "", # Properties of the object. Contains field @type with type URL. 1252 }, 1253 ], 1254 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1255 }, 1256 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1257 "a_key": "", # Properties of the object. Contains field @type with type URL. 1258 }, 1259 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1260 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1261 "a_key": "", # Properties of the object. Contains field @type with type URL. 1262 }, 1263}</pre> 1264</div> 1265 1266<div class="method"> 1267 <code class="details" id="upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</code> 1268 <pre>Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. 1269 1270Args: 1271 name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 1272 body: object, The request body. 1273 The object takes the form of: 1274 1275{ # Request for upgrading a notebook instance from within the VM 1276 "vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity 1277} 1278 1279 x__xgafv: string, V1 error format. 1280 Allowed values 1281 1 - v1 error format 1282 2 - v2 error format 1283 1284Returns: 1285 An object of the form: 1286 1287 { # This resource represents a long-running operation that is the result of a network API call. 1288 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1289 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1290 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1291 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1292 { 1293 "a_key": "", # Properties of the object. Contains field @type with type URL. 1294 }, 1295 ], 1296 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1297 }, 1298 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1299 "a_key": "", # Properties of the object. Contains field @type with type URL. 1300 }, 1301 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1302 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1303 "a_key": "", # Properties of the object. Contains field @type with type URL. 1304 }, 1305}</pre> 1306</div> 1307 1308</body></html>