Blame - docs/dyn/deploymentmanager_v2.deployments.html - platform/external/python/google-api-python-client

blob: 301bbfaf67e557b99f9a5f9f5c25884a7d72ce73 [file] [log] [blame]

Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[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="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.deployments.html">deployments</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#cancelPreview">cancelPreview(project, deployment, body)</a></code></p>
				79	<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(project, deployment)</a></code></p>
				82	<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(project, deployment)</a></code></p>
				85	<p class="firstline">Gets information about a specific deployment.</p>
				86	<p class="toc_element">
				87	<code><a href="#insert">insert(project, body, preview=None)</a></code></p>
				88	<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
				91	<p class="firstline">Lists all deployments for a given project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
				97	<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p>
				98	<p class="toc_element">
				99	<code><a href="#stop">stop(project, deployment, body)</a></code></p>
				100	<p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p>
				101	<p class="toc_element">
				102	<code><a href="#update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
				103	<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
				106	<code class="details" id="cancelPreview">cancelPreview(project, deployment, body)</code>
				107	<pre>Cancels and removes the preview currently associated with the deployment.
				108
				109	Args:
				110	project: string, The project ID for this request. (required)
				111	deployment: string, The name of the deployment for this request. (required)
				112	body: object, The request body. (required)
				113	The object takes the form of:
				114
				115	{
				116	"fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
				117	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	118	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	119	}
				120
				121
				122	Returns:
				123	An object of the form:
				124
				125	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	126	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				127	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	128	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	129	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				130	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				131	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				132	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	133	"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]	134	"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.
				135	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	136	"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]	137	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				138	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	139	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				140	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	141	"message": "A String", # [Output Only] A human-readable description of the warning code.
				142	"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.
				143	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				144	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	145	{
				146	"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]	147	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	148	},
				149	],
				150	},
				151	],
				152	"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]	153	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				154	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	155	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	156	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	157	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				158	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				159	{
				160	"message": "A String", # [Output Only] An optional, human-readable error message.
				161	"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]	162	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	163	},
				164	],
				165	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	166	"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]	167	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	168	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	169	}</pre>
				170	</div>
				171
				172	<div class="method">
				173	<code class="details" id="delete">delete(project, deployment)</code>
				174	<pre>Deletes a deployment and all of the resources in the deployment.
				175
				176	Args:
				177	project: string, The project ID for this request. (required)
				178	deployment: string, The name of the deployment for this request. (required)
				179
				180	Returns:
				181	An object of the form:
				182
				183	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	184	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				185	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	186	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	187	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				188	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				189	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				190	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	191	"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]	192	"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.
				193	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	194	"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]	195	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				196	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	197	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				198	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	199	"message": "A String", # [Output Only] A human-readable description of the warning code.
				200	"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.
				201	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				202	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	203	{
				204	"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]	205	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	206	},
				207	],
				208	},
				209	],
				210	"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]	211	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				212	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	213	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	214	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	215	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				216	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				217	{
				218	"message": "A String", # [Output Only] An optional, human-readable error message.
				219	"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]	220	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	221	},
				222	],
				223	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	224	"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]	225	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	226	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	227	}</pre>
				228	</div>
				229
				230	<div class="method">
				231	<code class="details" id="get">get(project, deployment)</code>
				232	<pre>Gets information about a specific deployment.
				233
				234	Args:
				235	project: string, The project ID for this request. (required)
				236	deployment: string, The name of the deployment for this request. (required)
				237
				238	Returns:
				239	An object of the form:
				240
				241	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	242	"description": "A String", # An optional user-provided description of the deployment.
				243	"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				244	{
				245	"value": "A String",
				246	"key": "A String",
				247	},
				248	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	249	"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	250	"labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				251	{
				252	"value": "A String",
				253	"key": "A String",
				254	},
				255	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	256	"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
				257	},
				258	"manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
				259	"insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
				260	"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
				261	#
				262	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
				263	"operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	264	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				265	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	266	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	267	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				268	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				269	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				270	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	271	"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]	272	"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.
				273	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	274	"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]	275	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				276	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	277	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				278	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	279	"message": "A String", # [Output Only] A human-readable description of the warning code.
				280	"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.
				281	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				282	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	283	{
				284	"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]	285	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	286	},
				287	],
				288	},
				289	],
				290	"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]	291	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				292	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	293	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	294	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	295	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				296	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				297	{
				298	"message": "A String", # [Output Only] An optional, human-readable error message.
				299	"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]	300	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	301	},
				302	],
				303	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	304	"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]	305	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	306	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	307	},
				308	"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
				309	"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
				310	{
				311	"content": "A String", # The contents of the file.
				312	"name": "A String", # The name of the file.
				313	},
				314	],
				315	"config": { # The configuration to use for this deployment.
				316	"content": "A String", # The contents of the file.
				317	},
				318	},
				319	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	320	"selfLink": "A String", # [Output Only] Self link for the deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	321	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	322	}</pre>
				323	</div>
				324
				325	<div class="method">
				326	<code class="details" id="insert">insert(project, body, preview=None)</code>
				327	<pre>Creates a deployment and all of the resources described by the deployment manifest.
				328
				329	Args:
				330	project: string, The project ID for this request. (required)
				331	body: object, The request body. (required)
				332	The object takes the form of:
				333
				334	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	335	"description": "A String", # An optional user-provided description of the deployment.
				336	"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				337	{
				338	"value": "A String",
				339	"key": "A String",
				340	},
				341	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	342	"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	343	"labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				344	{
				345	"value": "A String",
				346	"key": "A String",
				347	},
				348	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	349	"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
				350	},
				351	"manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
				352	"insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
				353	"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
				354	#
				355	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
				356	"operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	357	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				358	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	359	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	360	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				361	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				362	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				363	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	364	"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]	365	"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.
				366	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	367	"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]	368	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				369	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	370	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				371	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	372	"message": "A String", # [Output Only] A human-readable description of the warning code.
				373	"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.
				374	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				375	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	376	{
				377	"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]	378	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	379	},
				380	],
				381	},
				382	],
				383	"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]	384	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				385	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	386	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	387	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	388	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				389	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				390	{
				391	"message": "A String", # [Output Only] An optional, human-readable error message.
				392	"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]	393	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	394	},
				395	],
				396	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	397	"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]	398	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	399	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	400	},
				401	"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
				402	"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
				403	{
				404	"content": "A String", # The contents of the file.
				405	"name": "A String", # The name of the file.
				406	},
				407	],
				408	"config": { # The configuration to use for this deployment.
				409	"content": "A String", # The contents of the file.
				410	},
				411	},
				412	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	413	"selfLink": "A String", # [Output Only] Self link for the deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	414	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	415	}
				416
				417	preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
				418
				419	Returns:
				420	An object of the form:
				421
				422	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	423	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				424	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	425	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	426	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				427	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				428	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				429	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	430	"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]	431	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				432	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	433	"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]	434	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				435	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	436	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				437	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	438	"message": "A String", # [Output Only] A human-readable description of the warning code.
				439	"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.
				440	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				441	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	442	{
				443	"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]	444	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	445	},
				446	],
				447	},
				448	],
				449	"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]	450	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				451	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	452	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	453	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	454	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				455	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				456	{
				457	"message": "A String", # [Output Only] An optional, human-readable error message.
				458	"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]	459	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	460	},
				461	],
				462	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	463	"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]	464	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	465	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	466	}</pre>
				467	</div>
				468
				469	<div class="method">
				470	<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
				471	<pre>Lists all deployments for a given project.
				472
				473	Args:
				474	project: string, The project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	475	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.
				476	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.
				477	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]	478
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	479	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]	480
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	481	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]	482
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	483	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]	484
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	485	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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	486
				487	Returns:
				488	An object of the form:
				489
				490	{ # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
				491	"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
				492	"deployments": [ # [Output Only] The deployments contained in this response.
				493	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	494	"description": "A String", # An optional user-provided description of the deployment.
				495	"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				496	{
				497	"value": "A String",
				498	"key": "A String",
				499	},
				500	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	501	"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	502	"labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				503	{
				504	"value": "A String",
				505	"key": "A String",
				506	},
				507	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	508	"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
				509	},
				510	"manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
				511	"insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
				512	"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
				513	#
				514	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
				515	"operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	516	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				517	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	518	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	519	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				520	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				521	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				522	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	523	"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]	524	"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.
				525	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	526	"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]	527	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				528	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	529	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				530	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	531	"message": "A String", # [Output Only] A human-readable description of the warning code.
				532	"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.
				533	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				534	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	535	{
				536	"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]	537	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	538	},
				539	],
				540	},
				541	],
				542	"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]	543	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				544	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	545	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	546	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	547	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				548	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				549	{
				550	"message": "A String", # [Output Only] An optional, human-readable error message.
				551	"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]	552	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	553	},
				554	],
				555	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	556	"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]	557	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	558	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	559	},
				560	"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
				561	"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
				562	{
				563	"content": "A String", # The contents of the file.
				564	"name": "A String", # The name of the file.
				565	},
				566	],
				567	"config": { # The configuration to use for this deployment.
				568	"content": "A String", # The contents of the file.
				569	},
				570	},
				571	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	572	"selfLink": "A String", # [Output Only] Self link for the deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	573	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	574	},
				575	],
				576	}</pre>
				577	</div>
				578
				579	<div class="method">
				580	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				581	<pre>Retrieves the next page of results.
				582
				583	Args:
				584	previous_request: The request for the previous page. (required)
				585	previous_response: The response from the request for the previous page. (required)
				586
				587	Returns:
				588	A request object that you can call 'execute()' on to request the next
				589	page. Returns None if there are no more items in the collection.
				590	</pre>
				591	</div>
				592
				593	<div class="method">
				594	<code class="details" id="patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
				595	<pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
				596
				597	Args:
				598	project: string, The project ID for this request. (required)
				599	deployment: string, The name of the deployment for this request. (required)
				600	body: object, The request body. (required)
				601	The object takes the form of:
				602
				603	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	604	"description": "A String", # An optional user-provided description of the deployment.
				605	"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				606	{
				607	"value": "A String",
				608	"key": "A String",
				609	},
				610	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	611	"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	612	"labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				613	{
				614	"value": "A String",
				615	"key": "A String",
				616	},
				617	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	618	"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
				619	},
				620	"manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
				621	"insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
				622	"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
				623	#
				624	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
				625	"operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	626	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				627	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	628	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	629	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				630	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				631	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				632	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	633	"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]	634	"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.
				635	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	636	"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]	637	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				638	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	639	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				640	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	641	"message": "A String", # [Output Only] A human-readable description of the warning code.
				642	"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.
				643	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				644	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	645	{
				646	"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]	647	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	648	},
				649	],
				650	},
				651	],
				652	"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]	653	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				654	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	655	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	656	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	657	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				658	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				659	{
				660	"message": "A String", # [Output Only] An optional, human-readable error message.
				661	"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]	662	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	663	},
				664	],
				665	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	666	"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]	667	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	668	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	669	},
				670	"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
				671	"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
				672	{
				673	"content": "A String", # The contents of the file.
				674	"name": "A String", # The name of the file.
				675	},
				676	],
				677	"config": { # The configuration to use for this deployment.
				678	"content": "A String", # The contents of the file.
				679	},
				680	},
				681	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	682	"selfLink": "A String", # [Output Only] Self link for the deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	683	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	684	}
				685
				686	deletePolicy: string, Sets the policy to use for deleting resources.
				687	Allowed values
				688	ABANDON -
				689	DELETE -
				690	createPolicy: string, Sets the policy to use for creating new resources.
				691	Allowed values
				692	ACQUIRE -
				693	CREATE_OR_ACQUIRE -
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	694	preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	695
				696	Returns:
				697	An object of the form:
				698
				699	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	700	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				701	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	702	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	703	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				704	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				705	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				706	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	707	"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]	708	"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.
				709	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	710	"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]	711	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				712	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	713	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				714	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	715	"message": "A String", # [Output Only] A human-readable description of the warning code.
				716	"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.
				717	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				718	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	719	{
				720	"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]	721	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	722	},
				723	],
				724	},
				725	],
				726	"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]	727	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				728	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	729	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	730	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	731	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				732	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				733	{
				734	"message": "A String", # [Output Only] An optional, human-readable error message.
				735	"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]	736	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	737	},
				738	],
				739	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	740	"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]	741	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	742	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	743	}</pre>
				744	</div>
				745
				746	<div class="method">
				747	<code class="details" id="stop">stop(project, deployment, body)</code>
				748	<pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
				749
				750	Args:
				751	project: string, The project ID for this request. (required)
				752	deployment: string, The name of the deployment for this request. (required)
				753	body: object, The request body. (required)
				754	The object takes the form of:
				755
				756	{
				757	"fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
				758	#
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	759	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	760	}
				761
				762
				763	Returns:
				764	An object of the form:
				765
				766	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	767	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				768	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	769	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	770	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				771	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				772	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				773	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	774	"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]	775	"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.
				776	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	777	"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]	778	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				779	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	780	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				781	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	782	"message": "A String", # [Output Only] A human-readable description of the warning code.
				783	"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.
				784	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				785	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	786	{
				787	"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]	788	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	789	},
				790	],
				791	},
				792	],
				793	"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]	794	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				795	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	796	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	797	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	798	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				799	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				800	{
				801	"message": "A String", # [Output Only] An optional, human-readable error message.
				802	"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]	803	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	804	},
				805	],
				806	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	807	"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]	808	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	809	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	810	}</pre>
				811	</div>
				812
				813	<div class="method">
				814	<code class="details" id="update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
				815	<pre>Updates a deployment and all of the resources described by the deployment manifest.
				816
				817	Args:
				818	project: string, The project ID for this request. (required)
				819	deployment: string, The name of the deployment for this request. (required)
				820	body: object, The request body. (required)
				821	The object takes the form of:
				822
				823	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	824	"description": "A String", # An optional user-provided description of the deployment.
				825	"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				826	{
				827	"value": "A String",
				828	"key": "A String",
				829	},
				830	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	831	"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	832	"labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?
				833	{
				834	"value": "A String",
				835	"key": "A String",
				836	},
				837	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	838	"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
				839	},
				840	"manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
				841	"insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
				842	"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
				843	#
				844	# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
				845	"operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	846	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				847	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	848	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	849	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				850	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				851	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				852	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	853	"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]	854	"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.
				855	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	856	"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]	857	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				858	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	859	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				860	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	861	"message": "A String", # [Output Only] A human-readable description of the warning code.
				862	"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.
				863	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				864	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	865	{
				866	"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]	867	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	868	},
				869	],
				870	},
				871	],
				872	"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]	873	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				874	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	875	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	876	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	877	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				878	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				879	{
				880	"message": "A String", # [Output Only] An optional, human-readable error message.
				881	"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]	882	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	883	},
				884	],
				885	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	886	"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]	887	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	888	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	889	},
				890	"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
				891	"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
				892	{
				893	"content": "A String", # The contents of the file.
				894	"name": "A String", # The name of the file.
				895	},
				896	],
				897	"config": { # The configuration to use for this deployment.
				898	"content": "A String", # The contents of the file.
				899	},
				900	},
				901	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	902	"selfLink": "A String", # [Output Only] Self link for the deployment.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	903	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	904	}
				905
				906	deletePolicy: string, Sets the policy to use for deleting resources.
				907	Allowed values
				908	ABANDON -
				909	DELETE -
				910	createPolicy: string, Sets the policy to use for creating new resources.
				911	Allowed values
				912	ACQUIRE -
				913	CREATE_OR_ACQUIRE -
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	914	preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	915
				916	Returns:
				917	An object of the form:
				918
				919	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	920	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				921	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	922	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	923	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				924	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				925	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				926	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	927	"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]	928	"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.
				929	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	930	"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]	931	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				932	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	933	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				934	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	935	"message": "A String", # [Output Only] A human-readable description of the warning code.
				936	"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.
				937	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				938	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	939	{
				940	"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]	941	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	942	},
				943	],
				944	},
				945	],
				946	"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]	947	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				948	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	949	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	950	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	951	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				952	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				953	{
				954	"message": "A String", # [Output Only] An optional, human-readable error message.
				955	"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]	956	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	957	},
				958	],
				959	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	960	"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]	961	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	962	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	963	}</pre>
				964	</div>
				965
				966	</body></html>