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

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