Blame - docs/dyn/compute_v1.instances.html - platform/external/python/google-api-python-client

blob: 7706d49edbe482a89604c8c3df02a808f6f11589 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</a></code></p>
				79	<p class="firstline">Adds an access config to an instance's network interface.</p>
				80	<p class="toc_element">
				81	<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	82	<p class="firstline">Retrieves aggregated list of instances.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
				87	<code><a href="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	88	<p class="firstline">Attaches a Disk resource to an instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#delete">delete(project, zone, instance)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	91	<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
				94	<p class="firstline">Deletes an access config from an instance's network interface.</p>
				95	<p class="toc_element">
				96	<code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName)</a></code></p>
				97	<p class="firstline">Detaches a disk from an instance.</p>
				98	<p class="toc_element">
				99	<code><a href="#get">get(project, zone, instance)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	100	<p class="firstline">Returns the specified Instance resource. Get a list of available instances by making a list() request.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	101	<p class="toc_element">
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	102	<code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	103	<p class="firstline">Returns the specified instance's serial port output.</p>
				104	<p class="toc_element">
				105	<code><a href="#insert">insert(project, zone, body)</a></code></p>
				106	<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
				107	<p class="toc_element">
				108	<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	109	<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	110	<p class="toc_element">
				111	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				112	<p class="firstline">Retrieves the next page of results.</p>
				113	<p class="toc_element">
				114	<code><a href="#reset">reset(project, zone, instance)</a></code></p>
				115	<p class="firstline">Performs a hard reset on the instance.</p>
				116	<p class="toc_element">
				117	<code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	118	<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	119	<p class="toc_element">
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	120	<code><a href="#setMachineType">setMachineType(project, zone, instance, body)</a></code></p>
				121	<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
				122	<p class="toc_element">
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	123	<code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
				124	<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
				125	<p class="toc_element">
				126	<code><a href="#setScheduling">setScheduling(project, zone, instance, body)</a></code></p>
				127	<p class="firstline">Sets an instance's scheduling options.</p>
				128	<p class="toc_element">
				129	<code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
				130	<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	131	<p class="toc_element">
				132	<code><a href="#start">start(project, zone, instance)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	133	<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	134	<p class="toc_element">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	135	<code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</a></code></p>
				136	<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
				137	<p class="toc_element">
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	138	<code><a href="#stop">stop(project, zone, instance)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	139	<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	140	<h3>Method Details</h3>
				141	<div class="method">
				142	<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
				143	<pre>Adds an access config to an instance's network interface.
				144
				145	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	146	project: string, Project ID for this request. (required)
				147	zone: string, The name of the zone for this request. (required)
				148	instance: string, The instance name for this request. (required)
				149	networkInterface: string, The name of the network interface to add to this instance. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	150	body: object, The request body. (required)
				151	The object takes the form of:
				152
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	153	{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	154	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				155	"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	156	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	157	"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	158	}
				159
				160
				161	Returns:
				162	An object of the form:
				163
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	164	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	165	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				166	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	167	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	168	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				169	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				170	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				171	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	172	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	173	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				174	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	175	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	176	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				177	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	178	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	179	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	180	"message": "A String", # [Output Only] A human-readable description of the warning code.
				181	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				182	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				183	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	184	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	185	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	186	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	187	},
				188	],
				189	},
				190	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	191	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	192	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				193	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	194	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	195	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	196	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	197	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	198	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	199	"message": "A String", # [Output Only] An optional, human-readable error message.
				200	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	201	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	202	},
				203	],
				204	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	205	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	206	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	207	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	208	}</pre>
				209	</div>
				210
				211	<div class="method">
				212	<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	213	<pre>Retrieves aggregated list of instances.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	214
				215	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	216	project: string, Project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	217	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
				218	pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
				219	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	220
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	221	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	222
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	223	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	224
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	225	You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	226
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	227	To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	228
				229	Returns:
				230	An object of the form:
				231
				232	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	233	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	234	"items": { # [Output Only] A map of scoped instance lists.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	235	"a_key": { # [Output Only] Name of the scope containing this set of instances.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	236	"instances": [ # [Output Only] List of instances contained in this scope.
				237	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	238	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	239	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	240	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				241	"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	242	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	243	"zone": "A String", # [Output Only] URL of the zone where the instance resides.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	244	"tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	245	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				246	"A String",
				247	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	248	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
				249	#
				250	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	251	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	252	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				253	{ # An instance-attached disk resource.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	254	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
				255	#
				256	# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
				257	#
				258	# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
				259	#
				260	# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
				261	#
				262	# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
				263	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				264	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				265	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	266	"deviceName": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	267	#
				268	# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
				269	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				270	"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
				271	#
				272	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				273	#
				274	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	275	"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
				276	#
				277	# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
				278	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				279	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				280	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	281	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				282	"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	283	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				284	#
				285	# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
				286	#
				287	# projects/debian-cloud/global/images/family/debian-8
				288	#
				289	# Alternatively, use a specific version of a public operating system image:
				290	#
				291	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				292	#
				293	# To create a disk with a private image that you created, specify the image name in the following format:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	294	#
				295	# global/images/my-private-image
				296	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	297	# You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	298	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	299	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	300	"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
				301	#
				302	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				303	#
				304	# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
				305	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				306	# - projects/project/zones/zone/diskTypes/diskType
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	307	# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	308	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	309	"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
				310	"index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
				311	"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.
				312	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	313	"A String",
				314	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	315	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	316	"interface": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	317	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	318	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	319	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	320	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	321	"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	322	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				323	"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	324	"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
				325	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	326	"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	327	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	328	"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	329	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	330	# zones/us-central1-f/machineTypes/n1-standard-1
				331	#
				332	# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
				333	#
				334	# zones/zone/machineTypes/custom-CPUS-MEMORY
				335	#
				336	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				337	#
				338	# For a full list of restrictions, read the Specifications for custom machine types.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	339	"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	340	{ # A service account.
				341	"scopes": [ # The list of scopes to be made available for this service account.
				342	"A String",
				343	],
				344	"email": "A String", # Email address of the service account.
				345	},
				346	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	347	"networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	348	{ # A network interface resource attached to an instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	349	"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
				350	{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	351	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				352	"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	353	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	354	"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	355	},
				356	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	357	"networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	358	"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	359	"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	360	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				361	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	362	"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
				363	#
				364	# global/networks/default
				365	#
				366	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				367	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				368	# - projects/project/global/networks/network
				369	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	370	},
				371	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	372	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	373	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				374	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	375	"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	376	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				377	{
				378	"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
				379	"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
				380	},
				381	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	382	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				383	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	384	},
				385	},
				386	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	387	"warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	388	"message": "A String", # [Output Only] A human-readable description of the warning code.
				389	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				390	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				391	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	392	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	393	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	394	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	395	},
				396	],
				397	},
				398	},
				399	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	400	"kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	401	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				402	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	403	}</pre>
				404	</div>
				405
				406	<div class="method">
				407	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				408	<pre>Retrieves the next page of results.
				409
				410	Args:
				411	previous_request: The request for the previous page. (required)
				412	previous_response: The response from the request for the previous page. (required)
				413
				414	Returns:
				415	A request object that you can call 'execute()' on to request the next
				416	page. Returns None if there are no more items in the collection.
				417	</pre>
				418	</div>
				419
				420	<div class="method">
				421	<code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	422	<pre>Attaches a Disk resource to an instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	423
				424	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	425	project: string, Project ID for this request. (required)
				426	zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	427	instance: string, The instance name for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	428	body: object, The request body. (required)
				429	The object takes the form of:
				430
				431	{ # An instance-attached disk resource.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	432	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
				433	#
				434	# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
				435	#
				436	# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
				437	#
				438	# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
				439	#
				440	# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
				441	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				442	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				443	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	444	"deviceName": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	445	#
				446	# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
				447	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				448	"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
				449	#
				450	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				451	#
				452	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	453	"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
				454	#
				455	# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
				456	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				457	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				458	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	459	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				460	"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	461	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				462	#
				463	# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
				464	#
				465	# projects/debian-cloud/global/images/family/debian-8
				466	#
				467	# Alternatively, use a specific version of a public operating system image:
				468	#
				469	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				470	#
				471	# To create a disk with a private image that you created, specify the image name in the following format:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	472	#
				473	# global/images/my-private-image
				474	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	475	# You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	476	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	477	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	478	"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
				479	#
				480	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				481	#
				482	# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
				483	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				484	# - projects/project/zones/zone/diskTypes/diskType
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	485	# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	486	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	487	"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
				488	"index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
				489	"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.
				490	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	491	"A String",
				492	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	493	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	494	"interface": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	495	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	496	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	497	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	498
				499
				500	Returns:
				501	An object of the form:
				502
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	503	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	504	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				505	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	506	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	507	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				508	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				509	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				510	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	511	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	512	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				513	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	514	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	515	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				516	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	517	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	518	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	519	"message": "A String", # [Output Only] A human-readable description of the warning code.
				520	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				521	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				522	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	523	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	524	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	525	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	526	},
				527	],
				528	},
				529	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	530	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	531	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				532	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	533	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	534	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	535	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	536	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	537	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	538	"message": "A String", # [Output Only] An optional, human-readable error message.
				539	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	540	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	541	},
				542	],
				543	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	544	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	545	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	546	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	547	}</pre>
				548	</div>
				549
				550	<div class="method">
				551	<code class="details" id="delete">delete(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	552	<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	553
				554	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	555	project: string, Project ID for this request. (required)
				556	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	557	instance: string, Name of the instance resource to delete. (required)
				558
				559	Returns:
				560	An object of the form:
				561
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	562	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	563	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				564	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	565	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	566	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				567	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				568	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				569	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	570	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	571	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				572	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	573	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	574	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				575	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	576	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	577	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	578	"message": "A String", # [Output Only] A human-readable description of the warning code.
				579	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				580	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				581	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	582	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	583	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	584	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	585	},
				586	],
				587	},
				588	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	589	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	590	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				591	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	592	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	593	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	594	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	595	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	596	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	597	"message": "A String", # [Output Only] An optional, human-readable error message.
				598	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	599	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	600	},
				601	],
				602	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	603	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	604	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	605	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	606	}</pre>
				607	</div>
				608
				609	<div class="method">
				610	<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
				611	<pre>Deletes an access config from an instance's network interface.
				612
				613	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	614	project: string, Project ID for this request. (required)
				615	zone: string, The name of the zone for this request. (required)
				616	instance: string, The instance name for this request. (required)
				617	accessConfig: string, The name of the access config to delete. (required)
				618	networkInterface: string, The name of the network interface. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	619
				620	Returns:
				621	An object of the form:
				622
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	623	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	624	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				625	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	626	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	627	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				628	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				629	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				630	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	631	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	632	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				633	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	634	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	635	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				636	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	637	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	638	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	639	"message": "A String", # [Output Only] A human-readable description of the warning code.
				640	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				641	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				642	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	643	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	644	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	645	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	646	},
				647	],
				648	},
				649	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	650	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	651	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				652	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	653	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	654	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	655	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	656	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	657	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	658	"message": "A String", # [Output Only] An optional, human-readable error message.
				659	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	660	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	661	},
				662	],
				663	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	664	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	665	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	666	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	667	}</pre>
				668	</div>
				669
				670	<div class="method">
				671	<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
				672	<pre>Detaches a disk from an instance.
				673
				674	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	675	project: string, Project ID for this request. (required)
				676	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	677	instance: string, Instance name. (required)
				678	deviceName: string, Disk device name to detach. (required)
				679
				680	Returns:
				681	An object of the form:
				682
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	683	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	684	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				685	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	686	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	687	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				688	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				689	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				690	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	691	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	692	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				693	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	694	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	695	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				696	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	697	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	698	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	699	"message": "A String", # [Output Only] A human-readable description of the warning code.
				700	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				701	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				702	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	703	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	704	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	705	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	706	},
				707	],
				708	},
				709	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	710	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	711	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				712	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	713	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	714	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	715	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	716	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	717	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	718	"message": "A String", # [Output Only] An optional, human-readable error message.
				719	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	720	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	721	},
				722	],
				723	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	724	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	725	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	726	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	727	}</pre>
				728	</div>
				729
				730	<div class="method">
				731	<code class="details" id="get">get(project, zone, instance)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	732	<pre>Returns the specified Instance resource. Get a list of available instances by making a list() request.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	733
				734	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	735	project: string, Project ID for this request. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	736	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	737	instance: string, Name of the instance resource to return. (required)
				738
				739	Returns:
				740	An object of the form:
				741
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	742	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	743	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	744	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	745	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				746	"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	747	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	748	"zone": "A String", # [Output Only] URL of the zone where the instance resides.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	749	"tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	750	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				751	"A String",
				752	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	753	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
				754	#
				755	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	756	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	757	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				758	{ # An instance-attached disk resource.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	759	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
				760	#
				761	# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
				762	#
				763	# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
				764	#
				765	# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
				766	#
				767	# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
				768	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				769	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				770	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	771	"deviceName": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	772	#
				773	# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
				774	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				775	"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
				776	#
				777	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				778	#
				779	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	780	"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
				781	#
				782	# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
				783	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				784	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				785	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	786	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				787	"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	788	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				789	#
				790	# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
				791	#
				792	# projects/debian-cloud/global/images/family/debian-8
				793	#
				794	# Alternatively, use a specific version of a public operating system image:
				795	#
				796	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				797	#
				798	# To create a disk with a private image that you created, specify the image name in the following format:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	799	#
				800	# global/images/my-private-image
				801	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	802	# You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	803	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	804	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	805	"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
				806	#
				807	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				808	#
				809	# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
				810	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				811	# - projects/project/zones/zone/diskTypes/diskType
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	812	# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	813	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	814	"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
				815	"index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
				816	"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.
				817	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	818	"A String",
				819	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	820	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	821	"interface": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	822	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	823	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	824	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	825	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	826	"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	827	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				828	"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	829	"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
				830	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	831	"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	832	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	833	"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	834	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	835	# zones/us-central1-f/machineTypes/n1-standard-1
				836	#
				837	# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
				838	#
				839	# zones/zone/machineTypes/custom-CPUS-MEMORY
				840	#
				841	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				842	#
				843	# For a full list of restrictions, read the Specifications for custom machine types.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	844	"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	845	{ # A service account.
				846	"scopes": [ # The list of scopes to be made available for this service account.
				847	"A String",
				848	],
				849	"email": "A String", # Email address of the service account.
				850	},
				851	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	852	"networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	853	{ # A network interface resource attached to an instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	854	"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
				855	{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	856	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				857	"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	858	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	859	"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	860	},
				861	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	862	"networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	863	"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	864	"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	865	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				866	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	867	"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
				868	#
				869	# global/networks/default
				870	#
				871	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				872	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				873	# - projects/project/global/networks/network
				874	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	875	},
				876	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	877	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	878	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				879	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	880	"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	881	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				882	{
				883	"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
				884	"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
				885	},
				886	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	887	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				888	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	889	},
				890	}</pre>
				891	</div>
				892
				893	<div class="method">
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	894	<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	895	<pre>Returns the specified instance's serial port output.
				896
				897	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	898	project: string, Project ID for this request. (required)
				899	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	900	instance: string, Name of the instance scoping this request. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	901	port: integer, Specifies which COM or serial port to retrieve data from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	902
				903	Returns:
				904	An object of the form:
				905
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	906	{ # An instance's serial console output.
				907	"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	908	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	909	"contents": "A String", # [Output Only] The contents of the console output.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	910	}</pre>
				911	</div>
				912
				913	<div class="method">
				914	<code class="details" id="insert">insert(project, zone, body)</code>
				915	<pre>Creates an instance resource in the specified project using the data included in the request.
				916
				917	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	918	project: string, Project ID for this request. (required)
				919	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	920	body: object, The request body. (required)
				921	The object takes the form of:
				922
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	923	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	924	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	925	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	926	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				927	"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	928	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	929	"zone": "A String", # [Output Only] URL of the zone where the instance resides.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	930	"tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	931	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				932	"A String",
				933	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	934	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
				935	#
				936	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	937	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	938	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				939	{ # An instance-attached disk resource.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	940	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
				941	#
				942	# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
				943	#
				944	# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
				945	#
				946	# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
				947	#
				948	# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
				949	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				950	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				951	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	952	"deviceName": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	953	#
				954	# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
				955	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				956	"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
				957	#
				958	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				959	#
				960	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	961	"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
				962	#
				963	# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
				964	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				965	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				966	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	967	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				968	"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	969	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				970	#
				971	# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
				972	#
				973	# projects/debian-cloud/global/images/family/debian-8
				974	#
				975	# Alternatively, use a specific version of a public operating system image:
				976	#
				977	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				978	#
				979	# To create a disk with a private image that you created, specify the image name in the following format:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	980	#
				981	# global/images/my-private-image
				982	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	983	# You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	984	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	985	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	986	"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
				987	#
				988	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				989	#
				990	# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
				991	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				992	# - projects/project/zones/zone/diskTypes/diskType
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	993	# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	994	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	995	"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
				996	"index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
				997	"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.
				998	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	999	"A String",
				1000	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1001	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1002	"interface": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1003	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1004	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1005	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1006	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1007	"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1008	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				1009	"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1010	"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
				1011	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1012	"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1013	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1014	"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1015	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1016	# zones/us-central1-f/machineTypes/n1-standard-1
				1017	#
				1018	# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
				1019	#
				1020	# zones/zone/machineTypes/custom-CPUS-MEMORY
				1021	#
				1022	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				1023	#
				1024	# For a full list of restrictions, read the Specifications for custom machine types.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1025	"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1026	{ # A service account.
				1027	"scopes": [ # The list of scopes to be made available for this service account.
				1028	"A String",
				1029	],
				1030	"email": "A String", # Email address of the service account.
				1031	},
				1032	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1033	"networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1034	{ # A network interface resource attached to an instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1035	"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
				1036	{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1037	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				1038	"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1039	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1040	"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1041	},
				1042	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1043	"networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1044	"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1045	"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1046	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				1047	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1048	"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
				1049	#
				1050	# global/networks/default
				1051	#
				1052	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				1053	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				1054	# - projects/project/global/networks/network
				1055	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1056	},
				1057	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1058	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1059	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1060	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1061	"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1062	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				1063	{
				1064	"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
				1065	"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
				1066	},
				1067	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1068	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				1069	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1070	},
				1071	}
				1072
				1073
				1074	Returns:
				1075	An object of the form:
				1076
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1077	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1078	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1079	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1080	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1081	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1082	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1083	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1084	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1085	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1086	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1087	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1088	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1089	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1090	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1091	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1092	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1093	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1094	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1095	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1096	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1097	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1098	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1099	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1100	},
				1101	],
				1102	},
				1103	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1104	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1105	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1106	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1107	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1108	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1109	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1110	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1111	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1112	"message": "A String", # [Output Only] An optional, human-readable error message.
				1113	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1114	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1115	},
				1116	],
				1117	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1118	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1119	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1120	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1121	}</pre>
				1122	</div>
				1123
				1124	<div class="method">
				1125	<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1126	<pre>Retrieves the list of instances contained within the specified zone.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1127
				1128	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1129	project: string, Project ID for this request. (required)
				1130	zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1131	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
				1132	pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
				1133	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1134
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1135	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1136
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1137	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1138
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1139	You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1140
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1141	To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1142
				1143	Returns:
				1144	An object of the form:
				1145
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1146	{ # Contains a list of instances.
				1147	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				1148	"items": [ # [Output Only] A list of instances.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1149	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	1150	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1151	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1152	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				1153	"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1154	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1155	"zone": "A String", # [Output Only] URL of the zone where the instance resides.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1156	"tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1157	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				1158	"A String",
				1159	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1160	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
				1161	#
				1162	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1163	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1164	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				1165	{ # An instance-attached disk resource.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1166	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
				1167	#
				1168	# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
				1169	#
				1170	# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
				1171	#
				1172	# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
				1173	#
				1174	# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
				1175	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				1176	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				1177	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1178	"deviceName": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1179	#
				1180	# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
				1181	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				1182	"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
				1183	#
				1184	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				1185	#
				1186	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1187	"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
				1188	#
				1189	# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
				1190	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				1191	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				1192	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1193	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				1194	"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1195	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				1196	#
				1197	# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
				1198	#
				1199	# projects/debian-cloud/global/images/family/debian-8
				1200	#
				1201	# Alternatively, use a specific version of a public operating system image:
				1202	#
				1203	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				1204	#
				1205	# To create a disk with a private image that you created, specify the image name in the following format:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1206	#
				1207	# global/images/my-private-image
				1208	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1209	# You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1210	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1211	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1212	"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
				1213	#
				1214	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				1215	#
				1216	# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
				1217	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				1218	# - projects/project/zones/zone/diskTypes/diskType
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1219	# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1220	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1221	"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
				1222	"index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
				1223	"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.
				1224	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1225	"A String",
				1226	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1227	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1228	"interface": "A String", # Specifies 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.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1229	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1230	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1231	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1232	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1233	"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1234	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				1235	"scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1236	"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
				1237	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1238	"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1239	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1240	"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1241	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1242	# zones/us-central1-f/machineTypes/n1-standard-1
				1243	#
				1244	# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
				1245	#
				1246	# zones/zone/machineTypes/custom-CPUS-MEMORY
				1247	#
				1248	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				1249	#
				1250	# For a full list of restrictions, read the Specifications for custom machine types.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1251	"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1252	{ # A service account.
				1253	"scopes": [ # The list of scopes to be made available for this service account.
				1254	"A String",
				1255	],
				1256	"email": "A String", # Email address of the service account.
				1257	},
				1258	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1259	"networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1260	{ # A network interface resource attached to an instance.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1261	"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
				1262	{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1263	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				1264	"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1265	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1266	"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1267	},
				1268	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1269	"networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1270	"name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1271	"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1272	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				1273	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1274	"network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
				1275	#
				1276	# global/networks/default
				1277	#
				1278	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				1279	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				1280	# - projects/project/global/networks/network
				1281	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1282	},
				1283	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1284	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1285	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1286	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1287	"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1288	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				1289	{
				1290	"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
				1291	"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
				1292	},
				1293	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1294	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				1295	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1296	},
				1297	},
				1298	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1299	"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1300	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1301	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1302	}</pre>
				1303	</div>
				1304
				1305	<div class="method">
				1306	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				1307	<pre>Retrieves the next page of results.
				1308
				1309	Args:
				1310	previous_request: The request for the previous page. (required)
				1311	previous_response: The response from the request for the previous page. (required)
				1312
				1313	Returns:
				1314	A request object that you can call 'execute()' on to request the next
				1315	page. Returns None if there are no more items in the collection.
				1316	</pre>
				1317	</div>
				1318
				1319	<div class="method">
				1320	<code class="details" id="reset">reset(project, zone, instance)</code>
				1321	<pre>Performs a hard reset on the instance.
				1322
				1323	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1324	project: string, Project ID for this request. (required)
				1325	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1326	instance: string, Name of the instance scoping this request. (required)
				1327
				1328	Returns:
				1329	An object of the form:
				1330
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1331	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1332	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1333	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1334	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1335	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1336	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1337	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1338	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1339	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1340	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1341	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1342	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1343	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1344	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1345	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1346	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1347	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1348	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1349	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1350	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1351	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1352	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1353	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1354	},
				1355	],
				1356	},
				1357	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1358	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1359	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1360	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1361	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1362	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1363	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1364	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1365	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1366	"message": "A String", # [Output Only] An optional, human-readable error message.
				1367	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1368	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1369	},
				1370	],
				1371	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1372	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1373	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1374	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1375	}</pre>
				1376	</div>
				1377
				1378	<div class="method">
				1379	<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1380	<pre>Sets the auto-delete flag for a disk attached to an instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1381
				1382	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1383	project: string, Project ID for this request. (required)
				1384	zone: string, The name of the zone for this request. (required)
				1385	instance: string, The instance name. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1386	autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1387	deviceName: string, The device name of the disk to modify. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1388
				1389	Returns:
				1390	An object of the form:
				1391
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1392	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1393	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1394	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1395	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1396	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1397	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1398	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1399	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1400	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1401	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1402	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1403	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1404	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1405	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1406	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1407	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1408	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1409	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1410	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1411	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1412	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1413	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1414	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1415	},
				1416	],
				1417	},
				1418	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1419	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1420	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1421	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1422	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1423	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1424	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1425	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1426	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1427	"message": "A String", # [Output Only] An optional, human-readable error message.
				1428	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1429	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1430	},
				1431	],
				1432	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1433	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1434	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1435	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
				1436	}</pre>
				1437	</div>
				1438
				1439	<div class="method">
				1440	<code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
				1441	<pre>Changes the machine type for a stopped instance to the machine type specified in the request.
				1442
				1443	Args:
				1444	project: string, Project ID for this request. (required)
				1445	zone: string, The name of the zone for this request. (required)
				1446	instance: string, Name of the instance scoping this request. (required)
				1447	body: object, The request body. (required)
				1448	The object takes the form of:
				1449
				1450	{
				1451	"machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
				1452	}
				1453
				1454
				1455	Returns:
				1456	An object of the form:
				1457
				1458	{ # An Operation resource, used to manage asynchronous API requests.
				1459	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1460	"clientOperationId": "A String", # [Output Only] Reserved for future use.
				1461	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1462	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1463	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1464	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1465	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				1466	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				1467	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1468	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				1469	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1470	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1471	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1472	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1473	{
				1474	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1475	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1476	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1477	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1478	{
				1479	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1480	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1481	},
				1482	],
				1483	},
				1484	],
				1485	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				1486	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1487	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				1488	"name": "A String", # [Output Only] Name of the resource.
				1489	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				1490	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1491	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1492	{
				1493	"message": "A String", # [Output Only] An optional, human-readable error message.
				1494	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1495	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1496	},
				1497	],
				1498	},
				1499	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1500	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1501	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1502	}</pre>
				1503	</div>
				1504
				1505	<div class="method">
				1506	<code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
				1507	<pre>Sets metadata for the specified instance to the data included in the request.
				1508
				1509	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1510	project: string, Project ID for this request. (required)
				1511	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1512	instance: string, Name of the instance scoping this request. (required)
				1513	body: object, The request body. (required)
				1514	The object takes the form of:
				1515
				1516	{ # A metadata key/value entry.
				1517	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				1518	{
				1519	"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
				1520	"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
				1521	},
				1522	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1523	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				1524	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1525	}
				1526
				1527
				1528	Returns:
				1529	An object of the form:
				1530
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1531	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1532	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1533	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1534	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1535	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1536	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1537	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1538	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1539	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1540	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1541	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1542	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1543	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1544	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1545	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1546	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1547	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1548	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1549	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1550	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1551	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1552	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1553	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1554	},
				1555	],
				1556	},
				1557	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1558	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1559	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1560	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1561	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1562	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1563	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1564	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1565	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1566	"message": "A String", # [Output Only] An optional, human-readable error message.
				1567	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1568	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1569	},
				1570	],
				1571	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1572	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1573	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1574	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1575	}</pre>
				1576	</div>
				1577
				1578	<div class="method">
				1579	<code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
				1580	<pre>Sets an instance's scheduling options.
				1581
				1582	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1583	project: string, Project ID for this request. (required)
				1584	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1585	instance: string, Instance name. (required)
				1586	body: object, The request body. (required)
				1587	The object takes the form of:
				1588
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1589	{ # Sets the scheduling options for an Instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1590	"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
				1591	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1592	"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1593	}
				1594
				1595
				1596	Returns:
				1597	An object of the form:
				1598
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1599	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1600	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1601	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1602	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1603	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1604	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1605	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1606	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1607	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1608	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1609	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1610	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1611	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1612	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1613	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1614	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1615	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1616	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1617	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1618	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1619	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1620	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1621	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1622	},
				1623	],
				1624	},
				1625	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1626	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1627	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1628	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1629	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1630	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1631	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1632	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1633	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1634	"message": "A String", # [Output Only] An optional, human-readable error message.
				1635	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1636	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1637	},
				1638	],
				1639	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1640	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1641	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1642	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1643	}</pre>
				1644	</div>
				1645
				1646	<div class="method">
				1647	<code class="details" id="setTags">setTags(project, zone, instance, body)</code>
				1648	<pre>Sets tags for the specified instance to the data included in the request.
				1649
				1650	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1651	project: string, Project ID for this request. (required)
				1652	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1653	instance: string, Name of the instance scoping this request. (required)
				1654	body: object, The request body. (required)
				1655	The object takes the form of:
				1656
				1657	{ # A set of instance tags.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1658	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				1659	"A String",
				1660	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1661	"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
				1662	#
				1663	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1664	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1665
				1666
				1667	Returns:
				1668	An object of the form:
				1669
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1670	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1671	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1672	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1673	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1674	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1675	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1676	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1677	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1678	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1679	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1680	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1681	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1682	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1683	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1684	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1685	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1686	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1687	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1688	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1689	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1690	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1691	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1692	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1693	},
				1694	],
				1695	},
				1696	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1697	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1698	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1699	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1700	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1701	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1702	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1703	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1704	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1705	"message": "A String", # [Output Only] An optional, human-readable error message.
				1706	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1707	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1708	},
				1709	],
				1710	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1711	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1712	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1713	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1714	}</pre>
				1715	</div>
				1716
				1717	<div class="method">
				1718	<code class="details" id="start">start(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1719	<pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1720
				1721	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1722	project: string, Project ID for this request. (required)
				1723	zone: string, The name of the zone for this request. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1724	instance: string, Name of the instance resource to start. (required)
				1725
				1726	Returns:
				1727	An object of the form:
				1728
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1729	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1730	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1731	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1732	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1733	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1734	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1735	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1736	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1737	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1738	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1739	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1740	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1741	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1742	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1743	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1744	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1745	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1746	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1747	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1748	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1749	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1750	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1751	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1752	},
				1753	],
				1754	},
				1755	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1756	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1757	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1758	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1759	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1760	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1761	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1762	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1763	{
				1764	"message": "A String", # [Output Only] An optional, human-readable error message.
				1765	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1766	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1767	},
				1768	],
				1769	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1770	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1771	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1772	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1773	}</pre>
				1774	</div>
				1775
				1776	<div class="method">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1777	<code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</code>
				1778	<pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
				1779
				1780	Args:
				1781	project: string, Project ID for this request. (required)
				1782	zone: string, The name of the zone for this request. (required)
				1783	instance: string, Name of the instance resource to start. (required)
				1784	body: object, The request body. (required)
				1785	The object takes the form of:
				1786
				1787	{
				1788	"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
				1789	#
				1790	# In order to start the instance, the disk url and its corresponding key must be provided.
				1791	#
				1792	# If the disk is not protected with a customer-supplied encryption key it should not be specified.
				1793	{
				1794	"diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
				1795	"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
				1796	"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
				1797	},
				1798	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
				1799	},
				1800	],
				1801	}
				1802
				1803
				1804	Returns:
				1805	An object of the form:
				1806
				1807	{ # An Operation resource, used to manage asynchronous API requests.
				1808	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1809	"clientOperationId": "A String", # [Output Only] Reserved for future use.
				1810	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1811	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1812	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1813	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1814	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				1815	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				1816	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1817	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				1818	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1819	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1820	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1821	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1822	{
				1823	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1824	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1825	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1826	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1827	{
				1828	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1829	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				1830	},
				1831	],
				1832	},
				1833	],
				1834	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				1835	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1836	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				1837	"name": "A String", # [Output Only] Name of the resource.
				1838	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				1839	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1840	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1841	{
				1842	"message": "A String", # [Output Only] An optional, human-readable error message.
				1843	"code": "A String", # [Output Only] The error type identifier for this error.
				1844	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1845	},
				1846	],
				1847	},
				1848	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1849	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1850	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
				1851	}</pre>
				1852	</div>
				1853
				1854	<div class="method">
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1855	<code class="details" id="stop">stop(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1856	<pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1857
				1858	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1859	project: string, Project ID for this request. (required)
				1860	zone: string, The name of the zone for this request. (required)
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	1861	instance: string, Name of the instance resource to stop. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1862
				1863	Returns:
				1864	An object of the form:
				1865
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1866	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1867	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1868	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1869	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1870	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1871	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1872	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1873	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1874	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1875	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1876	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1877	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1878	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1879	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1880	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1881	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1882	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1883	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1884	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1885	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1886	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1887	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1888	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1889	},
				1890	],
				1891	},
				1892	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1893	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1894	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1895	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1896	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1897	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1898	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1899	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1900	{
				1901	"message": "A String", # [Output Only] An optional, human-readable error message.
				1902	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1903	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1904	},
				1905	],
				1906	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1907	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1908	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1909	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1910	}</pre>
				1911	</div>
				1912
				1913	</body></html>