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

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