Blame - docs/dyn/notebooks_v1.projects.locations.instances.html - platform/external/python/google-api-python-client

blob: e575deaf54ff09f3985ebc4ef11f90070f0f0bb5 [file] [log] [blame]

Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	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">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	99	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	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="#setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</a></code></p>
				115	<p class="firstline">Updates the guest accelerators of a single Instance.</p>
				116	<p class="toc_element">
				117	<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
				118	<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>
				119	<p class="toc_element">
				120	<code><a href="#setLabels">setLabels(name, body=None, x__xgafv=None)</a></code></p>
				121	<p class="firstline">Replaces all the labels of an Instance.</p>
				122	<p class="toc_element">
				123	<code><a href="#setMachineType">setMachineType(name, body=None, x__xgafv=None)</a></code></p>
				124	<p class="firstline">Updates the machine type of a single Instance.</p>
				125	<p class="toc_element">
				126	<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
				127	<p class="firstline">Starts a notebook instance.</p>
				128	<p class="toc_element">
				129	<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
				130	<p class="firstline">Stops a notebook instance.</p>
				131	<p class="toc_element">
				132	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
				133	<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>
				134	<p class="toc_element">
				135	<code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
				136	<p class="firstline">Upgrades a notebook instance to the latest version.</p>
				137	<p class="toc_element">
				138	<code><a href="#upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</a></code></p>
				139	<p class="firstline">Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.</p>
				140	<h3>Method Details</h3>
				141	<div class="method">
				142	<code class="details" id="close">close()</code>
				143	<pre>Close httplib2 connections.</pre>
				144	</div>
				145
				146	<div class="method">
				147	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
				148	<pre>Creates a new Instance in a given project and location.
				149
				150	Args:
				151	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
				152	body: object, The request body.
				153	The object takes the form of:
				154
				155	{ # The definition of a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	156	"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).
				157	"coreCount": "A String", # Count of cores of this accelerator.
				158	"type": "A String", # Type of this accelerator.
				159	},
				160	"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.
				161	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				162	"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.
				163	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				164	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				165	},
				166	"createTime": "A String", # Output only. Instance creation time.
				167	"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.
				168	"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.
				169	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				170	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				171	"disks": [ # Output only. Attached disks to notebook instance.
				172	{ # An instance-attached disk resource.
				173	"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).
				174	"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.
				175	"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.
				176	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				177	"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.
				178	{ # Guest OS features for boot disk.
				179	"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
				180	},
				181	],
				182	"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.
				183	"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
				184	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				185	"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.
				186	"A String",
				187	],
				188	"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
				189	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				190	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	191	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	192	],
				193	"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.
				194	"instanceOwners": [ # Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
				195	"A String",
				196	],
				197	"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).
				198	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				199	"a_key": "A String",
				200	},
				201	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				202	"metadata": { # Custom metadata to apply to this instance.
				203	"a_key": "A String",
				204	},
				205	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				206	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
				207	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				208	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				209	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				210	"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).
				211	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				212	"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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	213	"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
				214	"A String",
				215	],
				216	"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).
				217	"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.
				218	"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.
				219	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				220	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	221	"state": "A String", # Output only. The state of this instance.
				222	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	223	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				224	"A String",
				225	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	226	"updateTime": "A String", # Output only. Instance update time.
				227	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	228	{ # The entry of VM image upgrade history.
				229	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	230	"containerImage": "A String", # The container image before this instance upgrade.
				231	"createTime": "A String", # The time that this instance upgrade history entry is created.
				232	"framework": "A String", # The framework of this notebook instance.
				233	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				234	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	235	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				236	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"version": "A String", # The version of the notebook instance before this upgrade.
				238	"vmImage": "A String", # The VM image before this instance upgrade.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	239	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	240	],
				241	"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.
				242	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				243	"imageName": "A String", # Use VM image name to find the image.
				244	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				245	},
				246	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	247
				248	instanceId: string, Required. User-defined unique ID of this instance.
				249	x__xgafv: string, V1 error format.
				250	Allowed values
				251	1 - v1 error format
				252	2 - v2 error format
				253
				254	Returns:
				255	An object of the form:
				256
				257	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	258	"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.
				259	"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.
				260	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				261	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				262	{
				263	"a_key": "", # Properties of the object. Contains field @type with type URL.
				264	},
				265	],
				266	"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.
				267	},
				268	"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.
				269	"a_key": "", # Properties of the object. Contains field @type with type URL.
				270	},
				271	"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}`.
				272	"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`.
				273	"a_key": "", # Properties of the object. Contains field @type with type URL.
				274	},
				275	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	276	</div>
				277
				278	<div class="method">
				279	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				280	<pre>Deletes a single Instance.
				281
				282	Args:
				283	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				284	x__xgafv: string, V1 error format.
				285	Allowed values
				286	1 - v1 error format
				287	2 - v2 error format
				288
				289	Returns:
				290	An object of the form:
				291
				292	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	293	"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.
				294	"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.
				295	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				296	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				297	{
				298	"a_key": "", # Properties of the object. Contains field @type with type URL.
				299	},
				300	],
				301	"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.
				302	},
				303	"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.
				304	"a_key": "", # Properties of the object. Contains field @type with type URL.
				305	},
				306	"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}`.
				307	"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`.
				308	"a_key": "", # Properties of the object. Contains field @type with type URL.
				309	},
				310	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	311	</div>
				312
				313	<div class="method">
				314	<code class="details" id="get">get(name, x__xgafv=None)</code>
				315	<pre>Gets details of a single Instance.
				316
				317	Args:
				318	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				319	x__xgafv: string, V1 error format.
				320	Allowed values
				321	1 - v1 error format
				322	2 - v2 error format
				323
				324	Returns:
				325	An object of the form:
				326
				327	{ # The definition of a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	328	"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).
				329	"coreCount": "A String", # Count of cores of this accelerator.
				330	"type": "A String", # Type of this accelerator.
				331	},
				332	"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.
				333	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				334	"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.
				335	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				336	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				337	},
				338	"createTime": "A String", # Output only. Instance creation time.
				339	"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.
				340	"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.
				341	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				342	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				343	"disks": [ # Output only. Attached disks to notebook instance.
				344	{ # An instance-attached disk resource.
				345	"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).
				346	"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.
				347	"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.
				348	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				349	"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.
				350	{ # Guest OS features for boot disk.
				351	"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
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	352	},
				353	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	354	"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.
				355	"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
				356	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				357	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	358	"A String",
				359	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	360	"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
				361	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				362	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
				363	},
				364	],
				365	"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.
				366	"instanceOwners": [ # Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
				367	"A String",
				368	],
				369	"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).
				370	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				371	"a_key": "A String",
				372	},
				373	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				374	"metadata": { # Custom metadata to apply to this instance.
				375	"a_key": "A String",
				376	},
				377	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				378	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
				379	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				380	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				381	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				382	"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).
				383	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				384	"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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	385	"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
				386	"A String",
				387	],
				388	"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).
				389	"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.
				390	"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.
				391	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				392	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	393	"state": "A String", # Output only. The state of this instance.
				394	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	395	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				396	"A String",
				397	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	398	"updateTime": "A String", # Output only. Instance update time.
				399	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	400	{ # The entry of VM image upgrade history.
				401	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	402	"containerImage": "A String", # The container image before this instance upgrade.
				403	"createTime": "A String", # The time that this instance upgrade history entry is created.
				404	"framework": "A String", # The framework of this notebook instance.
				405	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				406	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	407	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				408	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	"version": "A String", # The version of the notebook instance before this upgrade.
				410	"vmImage": "A String", # The VM image before this instance upgrade.
				411	},
				412	],
				413	"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.
				414	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				415	"imageName": "A String", # Use VM image name to find the image.
				416	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				417	},
				418	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	419	</div>
				420
				421	<div class="method">
				422	<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
				423	<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
				424
				425	Args:
				426	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
				427	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).
				428	x__xgafv: string, V1 error format.
				429	Allowed values
				430	1 - v1 error format
				431	2 - v2 error format
				432
				433	Returns:
				434	An object of the form:
				435
				436	{ # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	437	"bindings": [ # Associates a list of `members` to 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 member.
				438	{ # Associates `members` with a `role`.
				439	"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 members 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).
				440	"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.
				441	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				442	"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.
				443	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	444	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
				446	"A String",
				447	],
				448	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				449	},
				450	],
				451	"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.
				452	"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).
				453	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	454	</div>
				455
				456	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	457	<code class="details" id="getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</code>
				458	<pre>Check if a notebook instance is healthy.
				459
				460	Args:
				461	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				462	x__xgafv: string, V1 error format.
				463	Allowed values
				464	1 - v1 error format
				465	2 - v2 error format
				466
				467	Returns:
				468	An object of the form:
				469
				470	{ # Response for checking if a notebook instance is healthy.
				471	"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" }
				472	"a_key": "A String",
				473	},
				474	"healthState": "A String", # Output only. Runtime health_state.
				475	}</pre>
				476	</div>
				477
				478	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	479	<code class="details" id="isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</code>
				480	<pre>Check if a notebook instance is upgradable.
				481
				482	Args:
				483	notebookInstance: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				484	x__xgafv: string, V1 error format.
				485	Allowed values
				486	1 - v1 error format
				487	2 - v2 error format
				488
				489	Returns:
				490	An object of the form:
				491
				492	{ # Response for checking if a notebook instance is upgradeable.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame^]	493	"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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	494	"upgradeInfo": "A String", # Additional information about upgrade.
				495	"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.
				496	"upgradeable": True or False, # If an instance is upgradeable.
				497	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	498	</div>
				499
				500	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	501	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	502	<pre>Lists instances in a given project and location.
				503
				504	Args:
				505	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	506	pageSize: integer, Maximum return size of the list call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	507	pageToken: string, A previous returned page token that can be used to continue listing from the last result.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	508	x__xgafv: string, V1 error format.
				509	Allowed values
				510	1 - v1 error format
				511	2 - v2 error format
				512
				513	Returns:
				514	An object of the form:
				515
				516	{ # Response for listing notebook instances.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	517	"instances": [ # A list of returned instances.
				518	{ # The definition of a notebook instance.
				519	"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).
				520	"coreCount": "A String", # Count of cores of this accelerator.
				521	"type": "A String", # Type of this accelerator.
				522	},
				523	"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.
				524	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				525	"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.
				526	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				527	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				528	},
				529	"createTime": "A String", # Output only. Instance creation time.
				530	"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.
				531	"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.
				532	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				533	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				534	"disks": [ # Output only. Attached disks to notebook instance.
				535	{ # An instance-attached disk resource.
				536	"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).
				537	"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.
				538	"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.
				539	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				540	"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.
				541	{ # Guest OS features for boot disk.
				542	"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
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	543	},
				544	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	545	"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.
				546	"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
				547	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				548	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	549	"A String",
				550	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	551	"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
				552	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				553	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	554	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	555	],
				556	"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.
				557	"instanceOwners": [ # Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
				558	"A String",
				559	],
				560	"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).
				561	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				562	"a_key": "A String",
				563	},
				564	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				565	"metadata": { # Custom metadata to apply to this instance.
				566	"a_key": "A String",
				567	},
				568	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				569	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
				570	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				571	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				572	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				573	"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).
				574	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				575	"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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	576	"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
				577	"A String",
				578	],
				579	"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).
				580	"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.
				581	"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.
				582	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				583	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	584	"state": "A String", # Output only. The state of this instance.
				585	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	586	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				587	"A String",
				588	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	589	"updateTime": "A String", # Output only. Instance update time.
				590	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	591	{ # The entry of VM image upgrade history.
				592	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	593	"containerImage": "A String", # The container image before this instance upgrade.
				594	"createTime": "A String", # The time that this instance upgrade history entry is created.
				595	"framework": "A String", # The framework of this notebook instance.
				596	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				597	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	598	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				599	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	600	"version": "A String", # The version of the notebook instance before this upgrade.
				601	"vmImage": "A String", # The VM image before this instance upgrade.
				602	},
				603	],
				604	"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.
				605	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				606	"imageName": "A String", # Use VM image name to find the image.
				607	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				608	},
				609	},
				610	],
				611	"nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call.
				612	"unreachable": [ # Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,
				613	"A String",
				614	],
				615	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	616	</div>
				617
				618	<div class="method">
				619	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				620	<pre>Retrieves the next page of results.
				621
				622	Args:
				623	previous_request: The request for the previous page. (required)
				624	previous_response: The response from the request for the previous page. (required)
				625
				626	Returns:
				627	A request object that you can call 'execute()' on to request the next
				628	page. Returns None if there are no more items in the collection.
				629	</pre>
				630	</div>
				631
				632	<div class="method">
				633	<code class="details" id="register">register(parent, body=None, x__xgafv=None)</code>
				634	<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.
				635
				636	Args:
				637	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
				638	body: object, The request body.
				639	The object takes the form of:
				640
				641	{ # Request for registering a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	642	"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.
				643	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	644
				645	x__xgafv: string, V1 error format.
				646	Allowed values
				647	1 - v1 error format
				648	2 - v2 error format
				649
				650	Returns:
				651	An object of the form:
				652
				653	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	654	"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.
				655	"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.
				656	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				657	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				658	{
				659	"a_key": "", # Properties of the object. Contains field @type with type URL.
				660	},
				661	],
				662	"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.
				663	},
				664	"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.
				665	"a_key": "", # Properties of the object. Contains field @type with type URL.
				666	},
				667	"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}`.
				668	"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`.
				669	"a_key": "", # Properties of the object. Contains field @type with type URL.
				670	},
				671	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	672	</div>
				673
				674	<div class="method">
				675	<code class="details" id="report">report(name, body=None, x__xgafv=None)</code>
				676	<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.
				677
				678	Args:
				679	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				680	body: object, The request body.
				681	The object takes the form of:
				682
				683	{ # Request for notebook instances to report information to Notebooks API.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	684	"metadata": { # The metadata reported to Notebooks API. This will be merged to the instance metadata store
				685	"a_key": "A String",
				686	},
				687	"vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
				688	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	689
				690	x__xgafv: string, V1 error format.
				691	Allowed values
				692	1 - v1 error format
				693	2 - v2 error format
				694
				695	Returns:
				696	An object of the form:
				697
				698	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	699	"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.
				700	"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.
				701	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				702	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				703	{
				704	"a_key": "", # Properties of the object. Contains field @type with type URL.
				705	},
				706	],
				707	"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.
				708	},
				709	"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.
				710	"a_key": "", # Properties of the object. Contains field @type with type URL.
				711	},
				712	"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}`.
				713	"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`.
				714	"a_key": "", # Properties of the object. Contains field @type with type URL.
				715	},
				716	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	717	</div>
				718
				719	<div class="method">
				720	<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
				721	<pre>Resets a notebook instance.
				722
				723	Args:
				724	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				725	body: object, The request body.
				726	The object takes the form of:
				727
				728	{ # Request for reseting a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	729	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	730
				731	x__xgafv: string, V1 error format.
				732	Allowed values
				733	1 - v1 error format
				734	2 - v2 error format
				735
				736	Returns:
				737	An object of the form:
				738
				739	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	740	"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.
				741	"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.
				742	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				743	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				744	{
				745	"a_key": "", # Properties of the object. Contains field @type with type URL.
				746	},
				747	],
				748	"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.
				749	},
				750	"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.
				751	"a_key": "", # Properties of the object. Contains field @type with type URL.
				752	},
				753	"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}`.
				754	"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`.
				755	"a_key": "", # Properties of the object. Contains field @type with type URL.
				756	},
				757	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	758	</div>
				759
				760	<div class="method">
				761	<code class="details" id="setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</code>
				762	<pre>Updates the guest accelerators of a single Instance.
				763
				764	Args:
				765	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				766	body: object, The request body.
				767	The object takes the form of:
				768
				769	{ # Request for setting instance accelerator.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	770	"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.
				771	"type": "A String", # Required. Type of this accelerator.
				772	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	773
				774	x__xgafv: string, V1 error format.
				775	Allowed values
				776	1 - v1 error format
				777	2 - v2 error format
				778
				779	Returns:
				780	An object of the form:
				781
				782	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	783	"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.
				784	"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.
				785	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				786	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				787	{
				788	"a_key": "", # Properties of the object. Contains field @type with type URL.
				789	},
				790	],
				791	"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.
				792	},
				793	"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.
				794	"a_key": "", # Properties of the object. Contains field @type with type URL.
				795	},
				796	"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}`.
				797	"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`.
				798	"a_key": "", # Properties of the object. Contains field @type with type URL.
				799	},
				800	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	801	</div>
				802
				803	<div class="method">
				804	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
				805	<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
				806
				807	Args:
				808	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
				809	body: object, The request body.
				810	The object takes the form of:
				811
				812	{ # Request message for `SetIamPolicy` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	813	"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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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.
				814	"bindings": [ # Associates a list of `members` to 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 member.
				815	{ # Associates `members` with a `role`.
				816	"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 members 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).
				817	"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.
				818	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				819	"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.
				820	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	821	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	822	"members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
				823	"A String",
				824	],
				825	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				826	},
				827	],
				828	"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.
				829	"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).
				830	},
				831	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	832
				833	x__xgafv: string, V1 error format.
				834	Allowed values
				835	1 - v1 error format
				836	2 - v2 error format
				837
				838	Returns:
				839	An object of the form:
				840
				841	{ # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	842	"bindings": [ # Associates a list of `members` to 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 member.
				843	{ # Associates `members` with a `role`.
				844	"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 members 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).
				845	"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.
				846	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				847	"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.
				848	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	849	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	850	"members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
				851	"A String",
				852	],
				853	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				854	},
				855	],
				856	"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.
				857	"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).
				858	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	859	</div>
				860
				861	<div class="method">
				862	<code class="details" id="setLabels">setLabels(name, body=None, x__xgafv=None)</code>
				863	<pre>Replaces all the labels of an Instance.
				864
				865	Args:
				866	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				867	body: object, The request body.
				868	The object takes the form of:
				869
				870	{ # Request for setting instance labels.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	871	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method
				872	"a_key": "A String",
				873	},
				874	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	875
				876	x__xgafv: string, V1 error format.
				877	Allowed values
				878	1 - v1 error format
				879	2 - v2 error format
				880
				881	Returns:
				882	An object of the form:
				883
				884	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	885	"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.
				886	"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.
				887	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				888	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				889	{
				890	"a_key": "", # Properties of the object. Contains field @type with type URL.
				891	},
				892	],
				893	"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.
				894	},
				895	"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.
				896	"a_key": "", # Properties of the object. Contains field @type with type URL.
				897	},
				898	"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}`.
				899	"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`.
				900	"a_key": "", # Properties of the object. Contains field @type with type URL.
				901	},
				902	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	903	</div>
				904
				905	<div class="method">
				906	<code class="details" id="setMachineType">setMachineType(name, body=None, x__xgafv=None)</code>
				907	<pre>Updates the machine type of a single Instance.
				908
				909	Args:
				910	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				911	body: object, The request body.
				912	The object takes the form of:
				913
				914	{ # Request for setting instance machine type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	915	"machineType": "A String", # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).
				916	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	917
				918	x__xgafv: string, V1 error format.
				919	Allowed values
				920	1 - v1 error format
				921	2 - v2 error format
				922
				923	Returns:
				924	An object of the form:
				925
				926	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	927	"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.
				928	"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.
				929	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				930	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				931	{
				932	"a_key": "", # Properties of the object. Contains field @type with type URL.
				933	},
				934	],
				935	"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.
				936	},
				937	"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.
				938	"a_key": "", # Properties of the object. Contains field @type with type URL.
				939	},
				940	"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}`.
				941	"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`.
				942	"a_key": "", # Properties of the object. Contains field @type with type URL.
				943	},
				944	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	945	</div>
				946
				947	<div class="method">
				948	<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
				949	<pre>Starts a notebook instance.
				950
				951	Args:
				952	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				953	body: object, The request body.
				954	The object takes the form of:
				955
				956	{ # Request for starting a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	957	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	958
				959	x__xgafv: string, V1 error format.
				960	Allowed values
				961	1 - v1 error format
				962	2 - v2 error format
				963
				964	Returns:
				965	An object of the form:
				966
				967	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	968	"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.
				969	"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.
				970	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				971	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				972	{
				973	"a_key": "", # Properties of the object. Contains field @type with type URL.
				974	},
				975	],
				976	"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.
				977	},
				978	"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.
				979	"a_key": "", # Properties of the object. Contains field @type with type URL.
				980	},
				981	"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}`.
				982	"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`.
				983	"a_key": "", # Properties of the object. Contains field @type with type URL.
				984	},
				985	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	986	</div>
				987
				988	<div class="method">
				989	<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
				990	<pre>Stops a notebook instance.
				991
				992	Args:
				993	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				994	body: object, The request body.
				995	The object takes the form of:
				996
				997	{ # Request for stopping a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	998	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	999
				1000	x__xgafv: string, V1 error format.
				1001	Allowed values
				1002	1 - v1 error format
				1003	2 - v2 error format
				1004
				1005	Returns:
				1006	An object of the form:
				1007
				1008	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1009	"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.
				1010	"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.
				1011	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1012	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1013	{
				1014	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1015	},
				1016	],
				1017	"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.
				1018	},
				1019	"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.
				1020	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1021	},
				1022	"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}`.
				1023	"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`.
				1024	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1025	},
				1026	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1027	</div>
				1028
				1029	<div class="method">
				1030	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
				1031	<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.
				1032
				1033	Args:
				1034	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)
				1035	body: object, The request body.
				1036	The object takes the form of:
				1037
				1038	{ # Request message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1039	"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).
				1040	"A String",
				1041	],
				1042	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1043
				1044	x__xgafv: string, V1 error format.
				1045	Allowed values
				1046	1 - v1 error format
				1047	2 - v2 error format
				1048
				1049	Returns:
				1050	An object of the form:
				1051
				1052	{ # Response message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1053	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				1054	"A String",
				1055	],
				1056	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1057	</div>
				1058
				1059	<div class="method">
				1060	<code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
				1061	<pre>Upgrades a notebook instance to the latest version.
				1062
				1063	Args:
				1064	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1065	body: object, The request body.
				1066	The object takes the form of:
				1067
				1068	{ # Request for upgrading a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1069	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1070
				1071	x__xgafv: string, V1 error format.
				1072	Allowed values
				1073	1 - v1 error format
				1074	2 - v2 error format
				1075
				1076	Returns:
				1077	An object of the form:
				1078
				1079	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1080	"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.
				1081	"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.
				1082	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1083	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1084	{
				1085	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1086	},
				1087	],
				1088	"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.
				1089	},
				1090	"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.
				1091	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1092	},
				1093	"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}`.
				1094	"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`.
				1095	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1096	},
				1097	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1098	</div>
				1099
				1100	<div class="method">
				1101	<code class="details" id="upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</code>
				1102	<pre>Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
				1103
				1104	Args:
				1105	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1106	body: object, The request body.
				1107	The object takes the form of:
				1108
				1109	{ # Request for upgrading a notebook instance from within the VM
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1110	"vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
				1111	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1112
				1113	x__xgafv: string, V1 error format.
				1114	Allowed values
				1115	1 - v1 error format
				1116	2 - v2 error format
				1117
				1118	Returns:
				1119	An object of the form:
				1120
				1121	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1122	"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.
				1123	"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.
				1124	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1125	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1126	{
				1127	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1128	},
				1129	],
				1130	"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.
				1131	},
				1132	"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.
				1133	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1134	},
				1135	"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}`.
				1136	"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`.
				1137	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1138	},
				1139	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1140	</div>
				1141
				1142	</body></html>