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

blob: ddbe5d7b951adb192ed29f7e648dbedaab986411 [file] [log] [blame]

Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="notebooks_v1.html">Notebooks API</a> . <a href="notebooks_v1.projects.html">projects</a> . <a href="notebooks_v1.projects.locations.html">locations</a> . <a href="notebooks_v1.projects.locations.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new Instance in a given project and location.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a single Instance.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets details of a single Instance.</p>
				89	<p class="toc_element">
				90	<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
				92	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	93	<code><a href="#getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Check if a notebook instance is healthy.</p>
				95	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	96	<code><a href="#isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Check if a notebook instance is upgradable.</p>
				98	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	99	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	100	<p class="firstline">Lists instances in a given project and location.</p>
				101	<p class="toc_element">
				102	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				103	<p class="firstline">Retrieves the next page of results.</p>
				104	<p class="toc_element">
				105	<code><a href="#register">register(parent, body=None, x__xgafv=None)</a></code></p>
				106	<p class="firstline">Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.</p>
				107	<p class="toc_element">
				108	<code><a href="#report">report(name, body=None, x__xgafv=None)</a></code></p>
				109	<p class="firstline">Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.</p>
				110	<p class="toc_element">
				111	<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Resets a notebook instance.</p>
				113	<p class="toc_element">
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	114	<code><a href="#rollback">rollback(name, body=None, x__xgafv=None)</a></code></p>
				115	<p class="firstline">Rollbacks a notebook instance to the previous version.</p>
				116	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	117	<code><a href="#setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</a></code></p>
				118	<p class="firstline">Updates the guest accelerators of a single Instance.</p>
				119	<p class="toc_element">
				120	<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
				121	<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
				122	<p class="toc_element">
				123	<code><a href="#setLabels">setLabels(name, body=None, x__xgafv=None)</a></code></p>
				124	<p class="firstline">Replaces all the labels of an Instance.</p>
				125	<p class="toc_element">
				126	<code><a href="#setMachineType">setMachineType(name, body=None, x__xgafv=None)</a></code></p>
				127	<p class="firstline">Updates the machine type of a single Instance.</p>
				128	<p class="toc_element">
				129	<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
				130	<p class="firstline">Starts a notebook instance.</p>
				131	<p class="toc_element">
				132	<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
				133	<p class="firstline">Stops a notebook instance.</p>
				134	<p class="toc_element">
				135	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
				136	<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
				137	<p class="toc_element">
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	138	<code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</a></code></p>
				139	<p class="firstline">Updates the Shielded instance configuration of a single Instance.</p>
				140	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	141	<code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
				142	<p class="firstline">Upgrades a notebook instance to the latest version.</p>
				143	<p class="toc_element">
				144	<code><a href="#upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</a></code></p>
				145	<p class="firstline">Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.</p>
				146	<h3>Method Details</h3>
				147	<div class="method">
				148	<code class="details" id="close">close()</code>
				149	<pre>Close httplib2 connections.</pre>
				150	</div>
				151
				152	<div class="method">
				153	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
				154	<pre>Creates a new Instance in a given project and location.
				155
				156	Args:
				157	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
				158	body: object, The request body.
				159	The object takes the form of:
				160
				161	{ # The definition of a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	162	"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).
				163	"coreCount": "A String", # Count of cores of this accelerator.
				164	"type": "A String", # Type of this accelerator.
				165	},
				166	"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.
				167	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				168	"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.
				169	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				170	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				171	},
				172	"createTime": "A String", # Output only. Instance creation time.
				173	"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.
				174	"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.
				175	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				176	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				177	"disks": [ # Output only. Attached disks to notebook instance.
				178	{ # An instance-attached disk resource.
				179	"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).
				180	"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.
				181	"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.
				182	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				183	"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.
				184	{ # Guest OS features for boot disk.
				185	"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
				186	},
				187	],
				188	"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.
				189	"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
				190	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				191	"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.
				192	"A String",
				193	],
				194	"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
				195	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				196	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	197	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	198	],
				199	"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.
				200	"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.
				201	"A String",
				202	],
				203	"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).
				204	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				205	"a_key": "A String",
				206	},
				207	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				208	"metadata": { # Custom metadata to apply to this instance.
				209	"a_key": "A String",
				210	},
				211	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				212	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	213	"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				215	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				216	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				217	"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).
				218	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				219	"serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	220	"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
				221	"A String",
				222	],
				223	"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features] (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
				224	"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
				225	"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
				226	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				227	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	228	"state": "A String", # Output only. The state of this instance.
				229	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	230	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				231	"A String",
				232	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	233	"updateTime": "A String", # Output only. Instance update time.
				234	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	235	{ # The entry of VM image upgrade history.
				236	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"containerImage": "A String", # The container image before this instance upgrade.
				238	"createTime": "A String", # The time that this instance upgrade history entry is created.
				239	"framework": "A String", # The framework of this notebook instance.
				240	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				241	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	242	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				243	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	244	"version": "A String", # The version of the notebook instance before this upgrade.
				245	"vmImage": "A String", # The VM image before this instance upgrade.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	246	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	247	],
				248	"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.
				249	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				250	"imageName": "A String", # Use VM image name to find the image.
				251	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				252	},
				253	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	254
				255	instanceId: string, Required. User-defined unique ID of this instance.
				256	x__xgafv: string, V1 error format.
				257	Allowed values
				258	1 - v1 error format
				259	2 - v2 error format
				260
				261	Returns:
				262	An object of the form:
				263
				264	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	"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.
				266	"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.
				267	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				268	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				269	{
				270	"a_key": "", # Properties of the object. Contains field @type with type URL.
				271	},
				272	],
				273	"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.
				274	},
				275	"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.
				276	"a_key": "", # Properties of the object. Contains field @type with type URL.
				277	},
				278	"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}`.
				279	"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`.
				280	"a_key": "", # Properties of the object. Contains field @type with type URL.
				281	},
				282	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	283	</div>
				284
				285	<div class="method">
				286	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				287	<pre>Deletes a single Instance.
				288
				289	Args:
				290	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				291	x__xgafv: string, V1 error format.
				292	Allowed values
				293	1 - v1 error format
				294	2 - v2 error format
				295
				296	Returns:
				297	An object of the form:
				298
				299	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	300	"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.
				301	"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.
				302	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				303	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				304	{
				305	"a_key": "", # Properties of the object. Contains field @type with type URL.
				306	},
				307	],
				308	"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.
				309	},
				310	"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.
				311	"a_key": "", # Properties of the object. Contains field @type with type URL.
				312	},
				313	"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}`.
				314	"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`.
				315	"a_key": "", # Properties of the object. Contains field @type with type URL.
				316	},
				317	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	318	</div>
				319
				320	<div class="method">
				321	<code class="details" id="get">get(name, x__xgafv=None)</code>
				322	<pre>Gets details of a single Instance.
				323
				324	Args:
				325	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				326	x__xgafv: string, V1 error format.
				327	Allowed values
				328	1 - v1 error format
				329	2 - v2 error format
				330
				331	Returns:
				332	An object of the form:
				333
				334	{ # The definition of a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	"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).
				336	"coreCount": "A String", # Count of cores of this accelerator.
				337	"type": "A String", # Type of this accelerator.
				338	},
				339	"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.
				340	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				341	"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.
				342	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				343	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				344	},
				345	"createTime": "A String", # Output only. Instance creation time.
				346	"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.
				347	"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.
				348	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				349	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				350	"disks": [ # Output only. Attached disks to notebook instance.
				351	{ # An instance-attached disk resource.
				352	"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).
				353	"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.
				354	"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.
				355	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				356	"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.
				357	{ # Guest OS features for boot disk.
				358	"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	359	},
				360	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	361	"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.
				362	"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
				363	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				364	"licenses": [ # A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	365	"A String",
				366	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	367	"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
				368	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				369	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
				370	},
				371	],
				372	"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.
				373	"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.
				374	"A String",
				375	],
				376	"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).
				377	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				378	"a_key": "A String",
				379	},
				380	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				381	"metadata": { # Custom metadata to apply to this instance.
				382	"a_key": "A String",
				383	},
				384	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				385	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	386	"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	387	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				388	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				389	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				390	"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).
				391	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				392	"serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	393	"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
				394	"A String",
				395	],
				396	"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features] (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
				397	"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
				398	"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
				399	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				400	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	401	"state": "A String", # Output only. The state of this instance.
				402	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	403	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				404	"A String",
				405	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	406	"updateTime": "A String", # Output only. Instance update time.
				407	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	408	{ # The entry of VM image upgrade history.
				409	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	"containerImage": "A String", # The container image before this instance upgrade.
				411	"createTime": "A String", # The time that this instance upgrade history entry is created.
				412	"framework": "A String", # The framework of this notebook instance.
				413	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				414	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	415	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				416	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	417	"version": "A String", # The version of the notebook instance before this upgrade.
				418	"vmImage": "A String", # The VM image before this instance upgrade.
				419	},
				420	],
				421	"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.
				422	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				423	"imageName": "A String", # Use VM image name to find the image.
				424	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				425	},
				426	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	427	</div>
				428
				429	<div class="method">
				430	<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
				431	<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
				432
				433	Args:
				434	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
				435	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).
				436	x__xgafv: string, V1 error format.
				437	Allowed values
				438	1 - v1 error format
				439	2 - v2 error format
				440
				441	Returns:
				442	An object of the form:
				443
				444	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"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.
				446	{ # Associates `members` with a `role`.
				447	"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).
				448	"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.
				449	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				450	"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.
				451	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	452	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	453	"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`.
				454	"A String",
				455	],
				456	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				457	},
				458	],
				459	"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.
				460	"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).
				461	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	462	</div>
				463
				464	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	465	<code class="details" id="getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</code>
				466	<pre>Check if a notebook instance is healthy.
				467
				468	Args:
				469	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				470	x__xgafv: string, V1 error format.
				471	Allowed values
				472	1 - v1 error format
				473	2 - v2 error format
				474
				475	Returns:
				476	An object of the form:
				477
				478	{ # Response for checking if a notebook instance is healthy.
				479	"healthInfo": { # Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
				480	"a_key": "A String",
				481	},
				482	"healthState": "A String", # Output only. Runtime health_state.
				483	}</pre>
				484	</div>
				485
				486	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	487	<code class="details" id="isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</code>
				488	<pre>Check if a notebook instance is upgradable.
				489
				490	Args:
				491	notebookInstance: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				492	x__xgafv: string, V1 error format.
				493	Allowed values
				494	1 - v1 error format
				495	2 - v2 error format
				496
				497	Returns:
				498	An object of the form:
				499
				500	{ # Response for checking if a notebook instance is upgradeable.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	501	"upgradeImage": "A String", # The new image self link this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	502	"upgradeInfo": "A String", # Additional information about upgrade.
				503	"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.
				504	"upgradeable": True or False, # If an instance is upgradeable.
				505	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	506	</div>
				507
				508	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	509	<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]	510	<pre>Lists instances in a given project and location.
				511
				512	Args:
				513	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	514	pageSize: integer, Maximum return size of the list call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	515	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]	516	x__xgafv: string, V1 error format.
				517	Allowed values
				518	1 - v1 error format
				519	2 - v2 error format
				520
				521	Returns:
				522	An object of the form:
				523
				524	{ # Response for listing notebook instances.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	525	"instances": [ # A list of returned instances.
				526	{ # The definition of a notebook instance.
				527	"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).
				528	"coreCount": "A String", # Count of cores of this accelerator.
				529	"type": "A String", # Type of this accelerator.
				530	},
				531	"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.
				532	"bootDiskType": "A String", # Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				533	"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.
				534	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				535	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				536	},
				537	"createTime": "A String", # Output only. Instance creation time.
				538	"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.
				539	"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.
				540	"dataDiskType": "A String", # Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).
				541	"diskEncryption": "A String", # Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
				542	"disks": [ # Output only. Attached disks to notebook instance.
				543	{ # An instance-attached disk resource.
				544	"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).
				545	"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.
				546	"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.
				547	"diskSizeGb": "A String", # Indicates the size of the disk in base-2 GB.
				548	"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.
				549	{ # Guest OS features for boot disk.
				550	"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	551	},
				552	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	553	"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.
				554	"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
				555	"kind": "A String", # Type of the resource. Always compute#attachedDisk for attached disks.
				556	"licenses": [ # A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	557	"A String",
				558	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	559	"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
				560	"source": "A String", # Indicates a valid partial or full URL to an existing Persistent Disk resource.
				561	"type": "A String", # Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	562	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	563	],
				564	"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.
				565	"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.
				566	"A String",
				567	],
				568	"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).
				569	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.
				570	"a_key": "A String",
				571	},
				572	"machineType": "A String", # Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.
				573	"metadata": { # Custom metadata to apply to this instance.
				574	"a_key": "A String",
				575	},
				576	"name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
				577	"network": "A String", # The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	578	"nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	579	"noProxyAccess": True or False, # If true, the notebook instance will not register with the proxy.
				580	"noPublicIp": True or False, # If true, no public IP will be assigned to this instance.
				581	"noRemoveDataDisk": True or False, # Input only. If true, the data disk will not be auto deleted when deleting the instance.
				582	"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).
				583	"proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook.
				584	"serviceAccount": "A String", # The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	585	"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
				586	"A String",
				587	],
				588	"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # Optional. Shielded VM configuration. [Images using supported Shielded VM features] (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
				589	"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
				590	"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
				591	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				592	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	593	"state": "A String", # Output only. The state of this instance.
				594	"subnet": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	595	"tags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
				596	"A String",
				597	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	598	"updateTime": "A String", # Output only. Instance update time.
				599	"upgradeHistory": [ # The upgrade history of this instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	600	{ # The entry of VM image upgrade history.
				601	"action": "A String", # Action. Rolloback or Upgrade.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	602	"containerImage": "A String", # The container image before this instance upgrade.
				603	"createTime": "A String", # The time that this instance upgrade history entry is created.
				604	"framework": "A String", # The framework of this notebook instance.
				605	"snapshot": "A String", # The snapshot of the boot disk of this notebook instance before upgrade.
				606	"state": "A String", # The state of this instance upgrade history entry.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	607	"targetImage": "A String", # Target VM Image. Format: ainotebooks-vm/project/image-name/name.
				608	"targetVersion": "A String", # Target VM Version, like m63.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	609	"version": "A String", # The version of the notebook instance before this upgrade.
				610	"vmImage": "A String", # The VM image before this instance upgrade.
				611	},
				612	],
				613	"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.
				614	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				615	"imageName": "A String", # Use VM image name to find the image.
				616	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				617	},
				618	},
				619	],
				620	"nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call.
				621	"unreachable": [ # Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,
				622	"A String",
				623	],
				624	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	625	</div>
				626
				627	<div class="method">
				628	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				629	<pre>Retrieves the next page of results.
				630
				631	Args:
				632	previous_request: The request for the previous page. (required)
				633	previous_response: The response from the request for the previous page. (required)
				634
				635	Returns:
				636	A request object that you can call 'execute()' on to request the next
				637	page. Returns None if there are no more items in the collection.
				638	</pre>
				639	</div>
				640
				641	<div class="method">
				642	<code class="details" id="register">register(parent, body=None, x__xgafv=None)</code>
				643	<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.
				644
				645	Args:
				646	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
				647	body: object, The request body.
				648	The object takes the form of:
				649
				650	{ # Request for registering a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	651	"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.
				652	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	653
				654	x__xgafv: string, V1 error format.
				655	Allowed values
				656	1 - v1 error format
				657	2 - v2 error format
				658
				659	Returns:
				660	An object of the form:
				661
				662	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	663	"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.
				664	"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.
				665	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				666	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				667	{
				668	"a_key": "", # Properties of the object. Contains field @type with type URL.
				669	},
				670	],
				671	"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.
				672	},
				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	},
				676	"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}`.
				677	"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`.
				678	"a_key": "", # Properties of the object. Contains field @type with type URL.
				679	},
				680	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	681	</div>
				682
				683	<div class="method">
				684	<code class="details" id="report">report(name, body=None, x__xgafv=None)</code>
				685	<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.
				686
				687	Args:
				688	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				689	body: object, The request body.
				690	The object takes the form of:
				691
				692	{ # Request for notebook instances to report information to Notebooks API.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	693	"metadata": { # The metadata reported to Notebooks API. This will be merged to the instance metadata store
				694	"a_key": "A String",
				695	},
				696	"vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
				697	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	698
				699	x__xgafv: string, V1 error format.
				700	Allowed values
				701	1 - v1 error format
				702	2 - v2 error format
				703
				704	Returns:
				705	An object of the form:
				706
				707	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	708	"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.
				709	"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.
				710	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				711	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				712	{
				713	"a_key": "", # Properties of the object. Contains field @type with type URL.
				714	},
				715	],
				716	"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.
				717	},
				718	"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.
				719	"a_key": "", # Properties of the object. Contains field @type with type URL.
				720	},
				721	"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}`.
				722	"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`.
				723	"a_key": "", # Properties of the object. Contains field @type with type URL.
				724	},
				725	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	726	</div>
				727
				728	<div class="method">
				729	<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
				730	<pre>Resets a notebook instance.
				731
				732	Args:
				733	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				734	body: object, The request body.
				735	The object takes the form of:
				736
				737	{ # Request for reseting a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	738	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	739
				740	x__xgafv: string, V1 error format.
				741	Allowed values
				742	1 - v1 error format
				743	2 - v2 error format
				744
				745	Returns:
				746	An object of the form:
				747
				748	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	749	"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.
				750	"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.
				751	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				752	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				753	{
				754	"a_key": "", # Properties of the object. Contains field @type with type URL.
				755	},
				756	],
				757	"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.
				758	},
				759	"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.
				760	"a_key": "", # Properties of the object. Contains field @type with type URL.
				761	},
				762	"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}`.
				763	"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`.
				764	"a_key": "", # Properties of the object. Contains field @type with type URL.
				765	},
				766	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	767	</div>
				768
				769	<div class="method">
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	770	<code class="details" id="rollback">rollback(name, body=None, x__xgafv=None)</code>
				771	<pre>Rollbacks a notebook instance to the previous version.
				772
				773	Args:
				774	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				775	body: object, The request body.
				776	The object takes the form of:
				777
				778	{ # Request for rollbacking a notebook instance
				779	"targetSnapshot": "A String", # Required. The snapshot for rollback. Example: "projects/test-project/global/snapshots/krwlzipynril".
				780	}
				781
				782	x__xgafv: string, V1 error format.
				783	Allowed values
				784	1 - v1 error format
				785	2 - v2 error format
				786
				787	Returns:
				788	An object of the form:
				789
				790	{ # This resource represents a long-running operation that is the result of a network API call.
				791	"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.
				792	"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.
				793	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				794	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				795	{
				796	"a_key": "", # Properties of the object. Contains field @type with type URL.
				797	},
				798	],
				799	"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.
				800	},
				801	"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.
				802	"a_key": "", # Properties of the object. Contains field @type with type URL.
				803	},
				804	"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}`.
				805	"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`.
				806	"a_key": "", # Properties of the object. Contains field @type with type URL.
				807	},
				808	}</pre>
				809	</div>
				810
				811	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	812	<code class="details" id="setAccelerator">setAccelerator(name, body=None, x__xgafv=None)</code>
				813	<pre>Updates the guest accelerators of a single Instance.
				814
				815	Args:
				816	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				817	body: object, The request body.
				818	The object takes the form of:
				819
				820	{ # Request for setting instance accelerator.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	821	"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.
				822	"type": "A String", # Required. Type of this accelerator.
				823	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	824
				825	x__xgafv: string, V1 error format.
				826	Allowed values
				827	1 - v1 error format
				828	2 - v2 error format
				829
				830	Returns:
				831	An object of the form:
				832
				833	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	834	"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.
				835	"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.
				836	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				837	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				838	{
				839	"a_key": "", # Properties of the object. Contains field @type with type URL.
				840	},
				841	],
				842	"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.
				843	},
				844	"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.
				845	"a_key": "", # Properties of the object. Contains field @type with type URL.
				846	},
				847	"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}`.
				848	"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`.
				849	"a_key": "", # Properties of the object. Contains field @type with type URL.
				850	},
				851	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	852	</div>
				853
				854	<div class="method">
				855	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
				856	<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
				857
				858	Args:
				859	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
				860	body: object, The request body.
				861	The object takes the form of:
				862
				863	{ # Request message for `SetIamPolicy` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	864	"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.
				865	"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.
				866	{ # Associates `members` with a `role`.
				867	"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).
				868	"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.
				869	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				870	"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.
				871	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	872	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	873	"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`.
				874	"A String",
				875	],
				876	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				877	},
				878	],
				879	"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.
				880	"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).
				881	},
				882	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	883
				884	x__xgafv: string, V1 error format.
				885	Allowed values
				886	1 - v1 error format
				887	2 - v2 error format
				888
				889	Returns:
				890	An object of the form:
				891
				892	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	893	"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.
				894	{ # Associates `members` with a `role`.
				895	"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).
				896	"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.
				897	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				898	"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.
				899	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	900	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	901	"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`.
				902	"A String",
				903	],
				904	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				905	},
				906	],
				907	"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.
				908	"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).
				909	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	910	</div>
				911
				912	<div class="method">
				913	<code class="details" id="setLabels">setLabels(name, body=None, x__xgafv=None)</code>
				914	<pre>Replaces all the labels of an Instance.
				915
				916	Args:
				917	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				918	body: object, The request body.
				919	The object takes the form of:
				920
				921	{ # Request for setting instance labels.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	922	"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method
				923	"a_key": "A String",
				924	},
				925	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	926
				927	x__xgafv: string, V1 error format.
				928	Allowed values
				929	1 - v1 error format
				930	2 - v2 error format
				931
				932	Returns:
				933	An object of the form:
				934
				935	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	936	"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.
				937	"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.
				938	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				939	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				940	{
				941	"a_key": "", # Properties of the object. Contains field @type with type URL.
				942	},
				943	],
				944	"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.
				945	},
				946	"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.
				947	"a_key": "", # Properties of the object. Contains field @type with type URL.
				948	},
				949	"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}`.
				950	"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`.
				951	"a_key": "", # Properties of the object. Contains field @type with type URL.
				952	},
				953	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	954	</div>
				955
				956	<div class="method">
				957	<code class="details" id="setMachineType">setMachineType(name, body=None, x__xgafv=None)</code>
				958	<pre>Updates the machine type of a single Instance.
				959
				960	Args:
				961	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				962	body: object, The request body.
				963	The object takes the form of:
				964
				965	{ # Request for setting instance machine type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	966	"machineType": "A String", # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).
				967	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	968
				969	x__xgafv: string, V1 error format.
				970	Allowed values
				971	1 - v1 error format
				972	2 - v2 error format
				973
				974	Returns:
				975	An object of the form:
				976
				977	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	978	"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.
				979	"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.
				980	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				981	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				982	{
				983	"a_key": "", # Properties of the object. Contains field @type with type URL.
				984	},
				985	],
				986	"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.
				987	},
				988	"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.
				989	"a_key": "", # Properties of the object. Contains field @type with type URL.
				990	},
				991	"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}`.
				992	"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`.
				993	"a_key": "", # Properties of the object. Contains field @type with type URL.
				994	},
				995	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	996	</div>
				997
				998	<div class="method">
				999	<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
				1000	<pre>Starts a notebook instance.
				1001
				1002	Args:
				1003	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1004	body: object, The request body.
				1005	The object takes the form of:
				1006
				1007	{ # Request for starting a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1008	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1009
				1010	x__xgafv: string, V1 error format.
				1011	Allowed values
				1012	1 - v1 error format
				1013	2 - v2 error format
				1014
				1015	Returns:
				1016	An object of the form:
				1017
				1018	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1019	"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.
				1020	"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.
				1021	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1022	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1023	{
				1024	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1025	},
				1026	],
				1027	"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.
				1028	},
				1029	"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.
				1030	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1031	},
				1032	"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}`.
				1033	"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`.
				1034	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1035	},
				1036	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1037	</div>
				1038
				1039	<div class="method">
				1040	<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
				1041	<pre>Stops a notebook instance.
				1042
				1043	Args:
				1044	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1045	body: object, The request body.
				1046	The object takes the form of:
				1047
				1048	{ # Request for stopping a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1049	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1050
				1051	x__xgafv: string, V1 error format.
				1052	Allowed values
				1053	1 - v1 error format
				1054	2 - v2 error format
				1055
				1056	Returns:
				1057	An object of the form:
				1058
				1059	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1060	"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.
				1061	"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.
				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	],
				1068	"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.
				1069	},
				1070	"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.
				1071	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1072	},
				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}`.
				1074	"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`.
				1075	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1076	},
				1077	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1078	</div>
				1079
				1080	<div class="method">
				1081	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
				1082	<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.
				1083
				1084	Args:
				1085	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)
				1086	body: object, The request body.
				1087	The object takes the form of:
				1088
				1089	{ # Request message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1090	"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).
				1091	"A String",
				1092	],
				1093	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1094
				1095	x__xgafv: string, V1 error format.
				1096	Allowed values
				1097	1 - v1 error format
				1098	2 - v2 error format
				1099
				1100	Returns:
				1101	An object of the form:
				1102
				1103	{ # Response message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1104	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				1105	"A String",
				1106	],
				1107	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1108	</div>
				1109
				1110	<div class="method">
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1111	<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</code>
				1112	<pre>Updates the Shielded instance configuration of a single Instance.
				1113
				1114	Args:
				1115	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1116	body: object, The request body.
				1117	The object takes the form of:
				1118
				1119	{ # Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
				1120	"shieldedInstanceConfig": { # A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. # ShieldedInstance configuration to be updated.
				1121	"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
				1122	"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
				1123	"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
				1124	},
				1125	}
				1126
				1127	x__xgafv: string, V1 error format.
				1128	Allowed values
				1129	1 - v1 error format
				1130	2 - v2 error format
				1131
				1132	Returns:
				1133	An object of the form:
				1134
				1135	{ # This resource represents a long-running operation that is the result of a network API call.
				1136	"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.
				1137	"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.
				1138	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1139	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1140	{
				1141	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1142	},
				1143	],
				1144	"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.
				1145	},
				1146	"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.
				1147	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1148	},
				1149	"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}`.
				1150	"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`.
				1151	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1152	},
				1153	}</pre>
				1154	</div>
				1155
				1156	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1157	<code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
				1158	<pre>Upgrades a notebook instance to the latest version.
				1159
				1160	Args:
				1161	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1162	body: object, The request body.
				1163	The object takes the form of:
				1164
				1165	{ # Request for upgrading a notebook instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1166	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1167
				1168	x__xgafv: string, V1 error format.
				1169	Allowed values
				1170	1 - v1 error format
				1171	2 - v2 error format
				1172
				1173	Returns:
				1174	An object of the form:
				1175
				1176	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1177	"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.
				1178	"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.
				1179	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1180	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1181	{
				1182	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1183	},
				1184	],
				1185	"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.
				1186	},
				1187	"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.
				1188	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1189	},
				1190	"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}`.
				1191	"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`.
				1192	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1193	},
				1194	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1195	</div>
				1196
				1197	<div class="method">
				1198	<code class="details" id="upgradeInternal">upgradeInternal(name, body=None, x__xgafv=None)</code>
				1199	<pre>Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
				1200
				1201	Args:
				1202	name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
				1203	body: object, The request body.
				1204	The object takes the form of:
				1205
				1206	{ # Request for upgrading a notebook instance from within the VM
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1207	"vmId": "A String", # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
				1208	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1209
				1210	x__xgafv: string, V1 error format.
				1211	Allowed values
				1212	1 - v1 error format
				1213	2 - v2 error format
				1214
				1215	Returns:
				1216	An object of the form:
				1217
				1218	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1219	"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.
				1220	"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.
				1221	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				1222	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				1223	{
				1224	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1225	},
				1226	],
				1227	"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.
				1228	},
				1229	"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.
				1230	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1231	},
				1232	"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}`.
				1233	"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`.
				1234	"a_key": "", # Properties of the object. Contains field @type with type URL.
				1235	},
				1236	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1237	</div>
				1238
				1239	</body></html>