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

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