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

blob: b946e7ce85e3685333be5529b7c8520941be99c7 [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">
				135	<code><a href="#stop">stop(project, zone, instance)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	136	<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]	137	<h3>Method Details</h3>
				138	<div class="method">
				139	<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
				140	<pre>Adds an access config to an instance's network interface.
				141
				142	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	143	project: string, Project ID for this request. (required)
				144	zone: string, The name of the zone for this request. (required)
				145	instance: string, The instance name for this request. (required)
				146	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]	147	body: object, The request body. (required)
				148	The object takes the form of:
				149
				150	{ # An access configuration attached to an instance's network interface.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	151	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				152	"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]	153	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	154	"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]	155	}
				156
				157
				158	Returns:
				159	An object of the form:
				160
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	161	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	162	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				163	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	164	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	165	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				166	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				167	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				168	"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]	169	"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]	170	"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.
				171	"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]	172	"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]	173	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				174	"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]	175	"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]	176	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	177	"message": "A String", # [Output Only] A human-readable description of the warning code.
				178	"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.
				179	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				180	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	181	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	182	"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^]	183	"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]	184	},
				185	],
				186	},
				187	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	188	"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]	189	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				190	"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]	191	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	192	"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]	193	"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]	194	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	195	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	196	"message": "A String", # [Output Only] An optional, human-readable error message.
				197	"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^]	198	"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]	199	},
				200	],
				201	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	202	"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]	203	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	204	"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]	205	}</pre>
				206	</div>
				207
				208	<div class="method">
				209	<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]	210	<pre>Retrieves aggregated list of instances.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	211
				212	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	213	project: string, Project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	214	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.
				215	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.
				216	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]	217
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	218	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]	219
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	220	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]	221
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	222	Compute Engine Beta API Only: When filtering in the Beta API, you can also 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]	223
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	224	The Beta API also supports filtering on multiple expressions by providing 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]	225
				226	Returns:
				227	An object of the form:
				228
				229	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	230	"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]	231	"items": { # [Output Only] A map of scoped instance lists.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	232	"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]	233	"instances": [ # [Output Only] List of instances contained in this scope.
				234	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	235	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
				236	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	237	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				238	"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]	239	"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]	240	"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^]	241	"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]	242	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				243	"A String",
				244	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	245	"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.
				246	#
				247	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	248	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	249	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				250	{ # An instance-attached disk resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	251	"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]	252	#
				253	# 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.
				254	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				255	"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.
				256	#
				257	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				258	#
				259	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				260	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				261	"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^]	262	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				263	#
				264	# 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:
				265	#
				266	# projects/debian-cloud/global/images/family/debian-8
				267	#
				268	# Alternatively, use a specific version of a public operating system image:
				269	#
				270	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				271	#
				272	# 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]	273	#
				274	# global/images/my-private-image
				275	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	276	# 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]	277	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	278	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	279	"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:
				280	#
				281	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				282	#
				283	# 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:
				284	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				285	# - projects/project/zones/zone/diskTypes/diskType
				286	# - zones/zone/diskTypes/diskType
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	287	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	288	"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).
				289	"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.
				290	"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.
				291	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	292	"A String",
				293	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	294	"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]	295	"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]	296	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
				297	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	298	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	299	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	300	"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]	301	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				302	"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]	303	"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.
				304	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	305	"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]	306	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	307	"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]	308	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	309	# zones/us-central1-f/machineTypes/n1-standard-1
				310	#
				311	# 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):
				312	#
				313	# zones/zone/machineTypes/custom-CPUS-MEMORY
				314	#
				315	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				316	#
				317	# For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	318	"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 Authenticating from Google Compute Engine for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	319	{ # A service account.
				320	"scopes": [ # The list of scopes to be made available for this service account.
				321	"A String",
				322	],
				323	"email": "A String", # Email address of the service account.
				324	},
				325	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	326	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	327	{ # A network interface resource attached to an instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	328	"accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	329	{ # An access configuration attached to an instance's network interface.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	330	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				331	"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]	332	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	333	"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]	334	},
				335	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	336	"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]	337	"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]	338	"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^]	339	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				340	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	341	"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:
				342	#
				343	# global/networks/default
				344	#
				345	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				346	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				347	# - projects/project/global/networks/network
				348	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	349	},
				350	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	351	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	352	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				353	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	354	"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]	355	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				356	{
				357	"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.
				358	"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.
				359	},
				360	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	361	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				362	"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]	363	},
				364	},
				365	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	366	"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]	367	"message": "A String", # [Output Only] A human-readable description of the warning code.
				368	"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.
				369	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				370	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	371	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	372	"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^]	373	"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]	374	},
				375	],
				376	},
				377	},
				378	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	379	"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]	380	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				381	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	382	}</pre>
				383	</div>
				384
				385	<div class="method">
				386	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				387	<pre>Retrieves the next page of results.
				388
				389	Args:
				390	previous_request: The request for the previous page. (required)
				391	previous_response: The response from the request for the previous page. (required)
				392
				393	Returns:
				394	A request object that you can call 'execute()' on to request the next
				395	page. Returns None if there are no more items in the collection.
				396	</pre>
				397	</div>
				398
				399	<div class="method">
				400	<code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	401	<pre>Attaches a Disk resource to an instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	402
				403	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	404	project: string, Project ID for this request. (required)
				405	zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	406	instance: string, The instance name for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	407	body: object, The request body. (required)
				408	The object takes the form of:
				409
				410	{ # An instance-attached disk resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	411	"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]	412	#
				413	# 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.
				414	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				415	"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.
				416	#
				417	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				418	#
				419	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				420	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				421	"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^]	422	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				423	#
				424	# 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:
				425	#
				426	# projects/debian-cloud/global/images/family/debian-8
				427	#
				428	# Alternatively, use a specific version of a public operating system image:
				429	#
				430	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				431	#
				432	# 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]	433	#
				434	# global/images/my-private-image
				435	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	436	# 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]	437	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	438	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	439	"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:
				440	#
				441	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				442	#
				443	# 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:
				444	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				445	# - projects/project/zones/zone/diskTypes/diskType
				446	# - zones/zone/diskTypes/diskType
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	447	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	448	"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).
				449	"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.
				450	"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.
				451	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	452	"A String",
				453	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	454	"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]	455	"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]	456	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
				457	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	458	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	459
				460
				461	Returns:
				462	An object of the form:
				463
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	464	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	465	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				466	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	467	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	468	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				469	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				470	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				471	"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]	472	"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]	473	"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.
				474	"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]	475	"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]	476	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				477	"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]	478	"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]	479	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	480	"message": "A String", # [Output Only] A human-readable description of the warning code.
				481	"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.
				482	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				483	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	484	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	485	"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^]	486	"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]	487	},
				488	],
				489	},
				490	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	491	"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]	492	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				493	"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]	494	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	495	"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]	496	"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]	497	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	498	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	499	"message": "A String", # [Output Only] An optional, human-readable error message.
				500	"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^]	501	"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]	502	},
				503	],
				504	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	505	"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]	506	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	507	"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]	508	}</pre>
				509	</div>
				510
				511	<div class="method">
				512	<code class="details" id="delete">delete(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	513	<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]	514
				515	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	516	project: string, Project ID for this request. (required)
				517	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	518	instance: string, Name of the instance resource to delete. (required)
				519
				520	Returns:
				521	An object of the form:
				522
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	523	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	524	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				525	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	526	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	527	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				528	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				529	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				530	"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]	531	"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]	532	"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.
				533	"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]	534	"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]	535	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				536	"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]	537	"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]	538	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	539	"message": "A String", # [Output Only] A human-readable description of the warning code.
				540	"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.
				541	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				542	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	543	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	544	"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^]	545	"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]	546	},
				547	],
				548	},
				549	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	550	"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]	551	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				552	"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]	553	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	554	"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]	555	"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]	556	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	557	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	558	"message": "A String", # [Output Only] An optional, human-readable error message.
				559	"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^]	560	"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]	561	},
				562	],
				563	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	564	"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]	565	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	566	"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]	567	}</pre>
				568	</div>
				569
				570	<div class="method">
				571	<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
				572	<pre>Deletes an access config from an instance's network interface.
				573
				574	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	575	project: string, Project ID for this request. (required)
				576	zone: string, The name of the zone for this request. (required)
				577	instance: string, The instance name for this request. (required)
				578	accessConfig: string, The name of the access config to delete. (required)
				579	networkInterface: string, The name of the network interface. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	580
				581	Returns:
				582	An object of the form:
				583
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	584	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	585	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				586	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	587	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	588	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				589	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				590	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				591	"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]	592	"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]	593	"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.
				594	"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]	595	"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]	596	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				597	"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]	598	"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]	599	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	600	"message": "A String", # [Output Only] A human-readable description of the warning code.
				601	"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.
				602	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				603	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	604	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	605	"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^]	606	"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]	607	},
				608	],
				609	},
				610	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	611	"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]	612	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				613	"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]	614	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	615	"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]	616	"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]	617	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	618	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	619	"message": "A String", # [Output Only] An optional, human-readable error message.
				620	"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^]	621	"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]	622	},
				623	],
				624	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	625	"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]	626	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	627	"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]	628	}</pre>
				629	</div>
				630
				631	<div class="method">
				632	<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
				633	<pre>Detaches a disk from an instance.
				634
				635	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	636	project: string, Project ID for this request. (required)
				637	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	638	instance: string, Instance name. (required)
				639	deviceName: string, Disk device name to detach. (required)
				640
				641	Returns:
				642	An object of the form:
				643
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	644	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	645	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				646	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	647	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	648	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				649	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				650	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				651	"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]	652	"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]	653	"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.
				654	"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]	655	"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]	656	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				657	"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]	658	"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]	659	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	660	"message": "A String", # [Output Only] A human-readable description of the warning code.
				661	"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.
				662	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				663	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	664	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	665	"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^]	666	"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]	667	},
				668	],
				669	},
				670	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	671	"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]	672	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				673	"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]	674	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	675	"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]	676	"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]	677	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	678	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	679	"message": "A String", # [Output Only] An optional, human-readable error message.
				680	"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^]	681	"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]	682	},
				683	],
				684	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	685	"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]	686	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	687	"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]	688	}</pre>
				689	</div>
				690
				691	<div class="method">
				692	<code class="details" id="get">get(project, zone, instance)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	693	<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]	694
				695	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	696	project: string, Project ID for this request. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	697	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	698	instance: string, Name of the instance resource to return. (required)
				699
				700	Returns:
				701	An object of the form:
				702
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	703	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	704	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
				705	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	706	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				707	"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]	708	"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]	709	"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^]	710	"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]	711	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				712	"A String",
				713	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	714	"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.
				715	#
				716	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	717	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	718	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				719	{ # An instance-attached disk resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	720	"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]	721	#
				722	# 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.
				723	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				724	"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.
				725	#
				726	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				727	#
				728	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				729	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				730	"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^]	731	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				732	#
				733	# 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:
				734	#
				735	# projects/debian-cloud/global/images/family/debian-8
				736	#
				737	# Alternatively, use a specific version of a public operating system image:
				738	#
				739	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				740	#
				741	# 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]	742	#
				743	# global/images/my-private-image
				744	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	745	# 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]	746	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	747	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	748	"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:
				749	#
				750	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				751	#
				752	# 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:
				753	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				754	# - projects/project/zones/zone/diskTypes/diskType
				755	# - zones/zone/diskTypes/diskType
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	756	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	757	"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).
				758	"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.
				759	"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.
				760	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	761	"A String",
				762	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	763	"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]	764	"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]	765	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
				766	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	767	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	768	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	769	"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]	770	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				771	"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]	772	"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.
				773	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	774	"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]	775	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	776	"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]	777	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	778	# zones/us-central1-f/machineTypes/n1-standard-1
				779	#
				780	# 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):
				781	#
				782	# zones/zone/machineTypes/custom-CPUS-MEMORY
				783	#
				784	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				785	#
				786	# For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	787	"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 Authenticating from Google Compute Engine for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	788	{ # A service account.
				789	"scopes": [ # The list of scopes to be made available for this service account.
				790	"A String",
				791	],
				792	"email": "A String", # Email address of the service account.
				793	},
				794	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	795	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	796	{ # A network interface resource attached to an instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	797	"accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	798	{ # An access configuration attached to an instance's network interface.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	799	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				800	"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]	801	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	802	"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]	803	},
				804	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	805	"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]	806	"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]	807	"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^]	808	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				809	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	810	"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:
				811	#
				812	# global/networks/default
				813	#
				814	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				815	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				816	# - projects/project/global/networks/network
				817	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	818	},
				819	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	820	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	821	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				822	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	823	"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]	824	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				825	{
				826	"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.
				827	"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.
				828	},
				829	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	830	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				831	"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]	832	},
				833	}</pre>
				834	</div>
				835
				836	<div class="method">
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	837	<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	838	<pre>Returns the specified instance's serial port output.
				839
				840	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	841	project: string, Project ID for this request. (required)
				842	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	843	instance: string, Name of the instance scoping this request. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	844	port: integer, Specifies which COM or serial port to retrieve data from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	845
				846	Returns:
				847	An object of the form:
				848
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	849	{ # An instance's serial console output.
				850	"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]	851	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	852	"contents": "A String", # [Output Only] The contents of the console output.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	853	}</pre>
				854	</div>
				855
				856	<div class="method">
				857	<code class="details" id="insert">insert(project, zone, body)</code>
				858	<pre>Creates an instance resource in the specified project using the data included in the request.
				859
				860	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	861	project: string, Project ID for this request. (required)
				862	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	863	body: object, The request body. (required)
				864	The object takes the form of:
				865
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	866	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	867	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
				868	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	869	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				870	"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]	871	"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]	872	"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^]	873	"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]	874	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				875	"A String",
				876	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	877	"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.
				878	#
				879	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	880	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	881	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				882	{ # An instance-attached disk resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	883	"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]	884	#
				885	# 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.
				886	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				887	"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.
				888	#
				889	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				890	#
				891	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				892	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				893	"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^]	894	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				895	#
				896	# 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:
				897	#
				898	# projects/debian-cloud/global/images/family/debian-8
				899	#
				900	# Alternatively, use a specific version of a public operating system image:
				901	#
				902	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				903	#
				904	# 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]	905	#
				906	# global/images/my-private-image
				907	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	908	# 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]	909	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	910	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	911	"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:
				912	#
				913	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				914	#
				915	# 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:
				916	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				917	# - projects/project/zones/zone/diskTypes/diskType
				918	# - zones/zone/diskTypes/diskType
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	919	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	920	"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).
				921	"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.
				922	"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.
				923	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	924	"A String",
				925	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	926	"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]	927	"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]	928	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
				929	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	930	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	931	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	932	"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]	933	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				934	"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]	935	"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.
				936	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	937	"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]	938	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	939	"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]	940	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	941	# zones/us-central1-f/machineTypes/n1-standard-1
				942	#
				943	# 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):
				944	#
				945	# zones/zone/machineTypes/custom-CPUS-MEMORY
				946	#
				947	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				948	#
				949	# For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	950	"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 Authenticating from Google Compute Engine for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	951	{ # A service account.
				952	"scopes": [ # The list of scopes to be made available for this service account.
				953	"A String",
				954	],
				955	"email": "A String", # Email address of the service account.
				956	},
				957	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	958	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	959	{ # A network interface resource attached to an instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	960	"accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	961	{ # An access configuration attached to an instance's network interface.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	962	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				963	"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]	964	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	965	"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]	966	},
				967	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	968	"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]	969	"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]	970	"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^]	971	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				972	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	973	"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:
				974	#
				975	# global/networks/default
				976	#
				977	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				978	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				979	# - projects/project/global/networks/network
				980	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	981	},
				982	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	983	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	984	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				985	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	986	"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]	987	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				988	{
				989	"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.
				990	"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.
				991	},
				992	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	993	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				994	"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]	995	},
				996	}
				997
				998
				999	Returns:
				1000	An object of the form:
				1001
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1002	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1003	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1004	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1005	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1006	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1007	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1008	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1009	"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]	1010	"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]	1011	"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.
				1012	"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]	1013	"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]	1014	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1015	"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]	1016	"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]	1017	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1018	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1019	"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.
				1020	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1021	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1022	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1023	"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^]	1024	"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]	1025	},
				1026	],
				1027	},
				1028	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1029	"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]	1030	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1031	"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]	1032	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1033	"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]	1034	"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]	1035	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1036	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1037	"message": "A String", # [Output Only] An optional, human-readable error message.
				1038	"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^]	1039	"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]	1040	},
				1041	],
				1042	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1043	"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]	1044	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1045	"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]	1046	}</pre>
				1047	</div>
				1048
				1049	<div class="method">
				1050	<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]	1051	<pre>Retrieves the list of instances contained within the specified zone.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1052
				1053	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1054	project: string, Project ID for this request. (required)
				1055	zone: string, The name of the zone for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1056	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.
				1057	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.
				1058	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]	1059
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1060	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]	1061
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1062	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]	1063
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1064	Compute Engine Beta API Only: When filtering in the Beta API, you can also 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]	1065
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1066	The Beta API also supports filtering on multiple expressions by providing 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]	1067
				1068	Returns:
				1069	An object of the form:
				1070
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1071	{ # Contains a list of instances.
				1072	"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.
				1073	"items": [ # [Output Only] A list of instances.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1074	{ # An Instance resource.
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	1075	"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
				1076	"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1077	"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
				1078	"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]	1079	"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]	1080	"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^]	1081	"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]	1082	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				1083	"A String",
				1084	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1085	"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.
				1086	#
				1087	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1088	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1089	"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
				1090	{ # An instance-attached disk resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1091	"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]	1092	#
				1093	# 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.
				1094	"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
				1095	"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.
				1096	#
				1097	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				1098	#
				1099	# This property is mutually exclusive with the source property; you can only define one or the other, but not both.
				1100	"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
				1101	"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^]	1102	"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
				1103	#
				1104	# 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:
				1105	#
				1106	# projects/debian-cloud/global/images/family/debian-8
				1107	#
				1108	# Alternatively, use a specific version of a public operating system image:
				1109	#
				1110	# projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
				1111	#
				1112	# 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]	1113	#
				1114	# global/images/my-private-image
				1115	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1116	# 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]	1117	#
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1118	# global/images/family/my-private-family
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1119	"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:
				1120	#
				1121	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
				1122	#
				1123	# 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:
				1124	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
				1125	# - projects/project/zones/zone/diskTypes/diskType
				1126	# - zones/zone/diskTypes/diskType
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1127	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1128	"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).
				1129	"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.
				1130	"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.
				1131	"licenses": [ # [Output Only] Any valid publicly visible licenses.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1132	"A String",
				1133	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1134	"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]	1135	"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]	1136	"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
				1137	"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1138	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1139	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1140	"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]	1141	"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
				1142	"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]	1143	"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.
				1144	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1145	"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]	1146	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1147	"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]	1148	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1149	# zones/us-central1-f/machineTypes/n1-standard-1
				1150	#
				1151	# 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):
				1152	#
				1153	# zones/zone/machineTypes/custom-CPUS-MEMORY
				1154	#
				1155	# For example: zones/us-central1-f/machineTypes/custom-4-5120
				1156	#
				1157	# For a full list of restrictions, read the Specifications for custom machine types.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1158	"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 Authenticating from Google Compute Engine for more information.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1159	{ # A service account.
				1160	"scopes": [ # The list of scopes to be made available for this service account.
				1161	"A String",
				1162	],
				1163	"email": "A String", # Email address of the service account.
				1164	},
				1165	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1166	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1167	{ # A network interface resource attached to an instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1168	"accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1169	{ # An access configuration attached to an instance's network interface.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1170	"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
				1171	"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]	1172	"name": "A String", # Name of this access configuration.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1173	"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]	1174	},
				1175	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	1176	"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]	1177	"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]	1178	"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^]	1179	# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
				1180	# - regions/region/subnetworks/subnetwork
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1181	"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:
				1182	#
				1183	# global/networks/default
				1184	#
				1185	# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				1186	# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
				1187	# - projects/project/global/networks/network
				1188	# - global/networks/default
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1189	},
				1190	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1191	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1192	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1193	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1194	"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]	1195	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				1196	{
				1197	"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.
				1198	"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.
				1199	},
				1200	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1201	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				1202	"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]	1203	},
				1204	},
				1205	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1206	"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]	1207	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1208	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1209	}</pre>
				1210	</div>
				1211
				1212	<div class="method">
				1213	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				1214	<pre>Retrieves the next page of results.
				1215
				1216	Args:
				1217	previous_request: The request for the previous page. (required)
				1218	previous_response: The response from the request for the previous page. (required)
				1219
				1220	Returns:
				1221	A request object that you can call 'execute()' on to request the next
				1222	page. Returns None if there are no more items in the collection.
				1223	</pre>
				1224	</div>
				1225
				1226	<div class="method">
				1227	<code class="details" id="reset">reset(project, zone, instance)</code>
				1228	<pre>Performs a hard reset on the instance.
				1229
				1230	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1231	project: string, Project ID for this request. (required)
				1232	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1233	instance: string, Name of the instance scoping this request. (required)
				1234
				1235	Returns:
				1236	An object of the form:
				1237
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1238	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1239	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1240	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1241	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1242	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1243	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1244	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1245	"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]	1246	"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]	1247	"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.
				1248	"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]	1249	"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]	1250	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1251	"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]	1252	"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]	1253	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1254	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1255	"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.
				1256	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1257	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1258	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1259	"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^]	1260	"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]	1261	},
				1262	],
				1263	},
				1264	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1265	"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]	1266	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1267	"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]	1268	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1269	"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]	1270	"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]	1271	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1272	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1273	"message": "A String", # [Output Only] An optional, human-readable error message.
				1274	"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^]	1275	"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]	1276	},
				1277	],
				1278	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1279	"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]	1280	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1281	"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]	1282	}</pre>
				1283	</div>
				1284
				1285	<div class="method">
				1286	<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1287	<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]	1288
				1289	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1290	project: string, Project ID for this request. (required)
				1291	zone: string, The name of the zone for this request. (required)
				1292	instance: string, The instance name. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1293	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]	1294	deviceName: string, The device name of the disk to modify. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1295
				1296	Returns:
				1297	An object of the form:
				1298
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1299	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1300	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1301	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1302	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1303	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1304	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1305	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1306	"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]	1307	"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]	1308	"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.
				1309	"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]	1310	"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]	1311	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1312	"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]	1313	"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]	1314	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1315	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1316	"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.
				1317	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1318	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1319	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1320	"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^]	1321	"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]	1322	},
				1323	],
				1324	},
				1325	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1326	"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]	1327	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1328	"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]	1329	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1330	"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]	1331	"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]	1332	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1333	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1334	"message": "A String", # [Output Only] An optional, human-readable error message.
				1335	"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^]	1336	"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]	1337	},
				1338	],
				1339	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1340	"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]	1341	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1342	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
				1343	}</pre>
				1344	</div>
				1345
				1346	<div class="method">
				1347	<code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
				1348	<pre>Changes the machine type for a stopped instance to the machine type specified in the request.
				1349
				1350	Args:
				1351	project: string, Project ID for this request. (required)
				1352	zone: string, The name of the zone for this request. (required)
				1353	instance: string, Name of the instance scoping this request. (required)
				1354	body: object, The request body. (required)
				1355	The object takes the form of:
				1356
				1357	{
				1358	"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
				1359	}
				1360
				1361
				1362	Returns:
				1363	An object of the form:
				1364
				1365	{ # An Operation resource, used to manage asynchronous API requests.
				1366	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1367	"clientOperationId": "A String", # [Output Only] Reserved for future use.
				1368	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1369	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1370	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1371	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1372	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				1373	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				1374	"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.
				1375	"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.
				1376	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1377	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1378	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1379	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1380	{
				1381	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1382	"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.
				1383	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1384	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1385	{
				1386	"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^]	1387	"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]	1388	},
				1389	],
				1390	},
				1391	],
				1392	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				1393	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1394	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				1395	"name": "A String", # [Output Only] Name of the resource.
				1396	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				1397	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1398	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1399	{
				1400	"message": "A String", # [Output Only] An optional, human-readable error message.
				1401	"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^]	1402	"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]	1403	},
				1404	],
				1405	},
				1406	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1407	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1408	"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]	1409	}</pre>
				1410	</div>
				1411
				1412	<div class="method">
				1413	<code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
				1414	<pre>Sets metadata for the specified instance to the data included in the request.
				1415
				1416	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1417	project: string, Project ID for this request. (required)
				1418	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1419	instance: string, Name of the instance scoping this request. (required)
				1420	body: object, The request body. (required)
				1421	The object takes the form of:
				1422
				1423	{ # A metadata key/value entry.
				1424	"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
				1425	{
				1426	"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.
				1427	"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.
				1428	},
				1429	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1430	"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
				1431	"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]	1432	}
				1433
				1434
				1435	Returns:
				1436	An object of the form:
				1437
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1438	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1439	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1440	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1441	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1442	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1443	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1444	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1445	"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]	1446	"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]	1447	"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.
				1448	"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]	1449	"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]	1450	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1451	"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]	1452	"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]	1453	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1454	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1455	"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.
				1456	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1457	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1458	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1459	"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^]	1460	"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]	1461	},
				1462	],
				1463	},
				1464	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1465	"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]	1466	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1467	"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]	1468	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1469	"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]	1470	"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]	1471	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1472	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1473	"message": "A String", # [Output Only] An optional, human-readable error message.
				1474	"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^]	1475	"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]	1476	},
				1477	],
				1478	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1479	"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]	1480	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1481	"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]	1482	}</pre>
				1483	</div>
				1484
				1485	<div class="method">
				1486	<code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
				1487	<pre>Sets an instance's scheduling options.
				1488
				1489	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1490	project: string, Project ID for this request. (required)
				1491	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1492	instance: string, Instance name. (required)
				1493	body: object, The request body. (required)
				1494	The object takes the form of:
				1495
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1496	{ # Sets the scheduling options for an Instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1497	"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.
				1498	"preemptible": True or False, # Whether the instance is preemptible.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1499	"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]	1500	}
				1501
				1502
				1503	Returns:
				1504	An object of the form:
				1505
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1506	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1507	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1508	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1509	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1510	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1511	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1512	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1513	"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]	1514	"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]	1515	"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.
				1516	"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]	1517	"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]	1518	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1519	"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]	1520	"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]	1521	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1522	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1523	"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.
				1524	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1525	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1526	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1527	"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^]	1528	"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]	1529	},
				1530	],
				1531	},
				1532	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1533	"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]	1534	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1535	"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]	1536	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1537	"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]	1538	"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]	1539	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1540	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1541	"message": "A String", # [Output Only] An optional, human-readable error message.
				1542	"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^]	1543	"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]	1544	},
				1545	],
				1546	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1547	"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]	1548	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1549	"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]	1550	}</pre>
				1551	</div>
				1552
				1553	<div class="method">
				1554	<code class="details" id="setTags">setTags(project, zone, instance, body)</code>
				1555	<pre>Sets tags for the specified instance to the data included in the request.
				1556
				1557	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1558	project: string, Project ID for this request. (required)
				1559	zone: string, The name of the zone for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1560	instance: string, Name of the instance scoping this request. (required)
				1561	body: object, The request body. (required)
				1562	The object takes the form of:
				1563
				1564	{ # A set of instance tags.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1565	"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
				1566	"A String",
				1567	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1568	"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.
				1569	#
				1570	# To see the latest fingerprint, make get() request to the instance.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	1571	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1572
				1573
				1574	Returns:
				1575	An object of the form:
				1576
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1577	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1578	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1579	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1580	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1581	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1582	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1583	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1584	"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]	1585	"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]	1586	"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.
				1587	"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]	1588	"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]	1589	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1590	"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]	1591	"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]	1592	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1593	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1594	"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.
				1595	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1596	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1597	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1598	"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^]	1599	"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]	1600	},
				1601	],
				1602	},
				1603	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1604	"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]	1605	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1606	"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]	1607	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1608	"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]	1609	"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]	1610	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1611	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1612	"message": "A String", # [Output Only] An optional, human-readable error message.
				1613	"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^]	1614	"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]	1615	},
				1616	],
				1617	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1618	"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]	1619	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1620	"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]	1621	}</pre>
				1622	</div>
				1623
				1624	<div class="method">
				1625	<code class="details" id="start">start(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1626	<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]	1627
				1628	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1629	project: string, Project ID for this request. (required)
				1630	zone: string, The name of the zone for this request. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1631	instance: string, Name of the instance resource to start. (required)
				1632
				1633	Returns:
				1634	An object of the form:
				1635
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1636	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1637	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1638	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1639	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1640	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1641	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1642	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1643	"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]	1644	"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]	1645	"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.
				1646	"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]	1647	"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]	1648	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1649	"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]	1650	"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]	1651	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1652	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1653	"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.
				1654	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1655	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1656	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1657	"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^]	1658	"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]	1659	},
				1660	],
				1661	},
				1662	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1663	"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]	1664	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1665	"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]	1666	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1667	"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]	1668	"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]	1669	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1670	{
				1671	"message": "A String", # [Output Only] An optional, human-readable error message.
				1672	"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^]	1673	"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]	1674	},
				1675	],
				1676	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1677	"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]	1678	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1679	"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]	1680	}</pre>
				1681	</div>
				1682
				1683	<div class="method">
				1684	<code class="details" id="stop">stop(project, zone, instance)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1685	<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]	1686
				1687	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1688	project: string, Project ID for this request. (required)
				1689	zone: string, The name of the zone for this request. (required)
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	1690	instance: string, Name of the instance resource to stop. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1691
				1692	Returns:
				1693	An object of the form:
				1694
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1695	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1696	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1697	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1698	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1699	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1700	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				1701	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1702	"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]	1703	"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]	1704	"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.
				1705	"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]	1706	"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]	1707	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				1708	"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]	1709	"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]	1710	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1711	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1712	"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.
				1713	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1714	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	1715	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1716	"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^]	1717	"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]	1718	},
				1719	],
				1720	},
				1721	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	1722	"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]	1723	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1724	"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]	1725	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1726	"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]	1727	"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]	1728	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1729	{
				1730	"message": "A String", # [Output Only] An optional, human-readable error message.
				1731	"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^]	1732	"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]	1733	},
				1734	],
				1735	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1736	"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]	1737	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1738	"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]	1739	}</pre>
				1740	</div>
				1741
				1742	</body></html>