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

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