Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / deploymentmanager_v2.deployments.html
blob: 59b0cea0aa1c3ee3ec7b9526e574d31d39b36a8e [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]75<h1><a href="deploymentmanager_v2.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_v2.deployments.html">deployments</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]78 <code><a href="#cancelPreview">cancelPreview(project, deployment, body=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]79<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>
80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]84 <code><a href="#delete">delete(project, deployment, deletePolicy=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]87 <code><a href="#get">get(project, deployment, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88<p class="firstline">Gets information about a specific deployment.</p>
89<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]90 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]91<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
92<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]93 <code><a href="#insert">insert(project, body=None, preview=None, createPolicy=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]94<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
95<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]96 <code><a href="#list">list(project, returnPartialSuccess=None, filter=None, orderBy=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97<p class="firstline">Lists all deployments for a given project.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]102 <code><a href="#patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]103<p class="firstline">Patches a deployment and all of the resources described by the deployment manifest.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]105 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]106<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
107<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]108 <code><a href="#stop">stop(project, deployment, body=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109<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>
110<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]111 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
113<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]114 <code><a href="#update">update(project, deployment, body=None, createPolicy=None, preview=None, deletePolicy=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
116<h3>Method Details</h3>
117<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]118 <code class="details" id="cancelPreview">cancelPreview(project, deployment, body=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]119 <pre>Cancels and removes the preview currently associated with the deployment.
120
121Args:
122 project: string, The project ID for this request. (required)
123 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 The object takes the form of:
126
127{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]128 &quot;fingerprint&quot;: &quot;A String&quot;, # 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). 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]129 }
130
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]135
136Returns:
137 An object of the form:
138
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]139 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]140 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]141 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]142 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]143 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]144 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
145 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]146 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
147 {
148 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]149 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]150 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
151 {
152 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
153 &quot;key&quot;: &quot;A String&quot;, # [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).
154 },
155 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]156 },
157 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]158 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
159 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
160 &quot;progress&quot;: 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.
161 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
162 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
163 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
164 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
166 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]167 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]168 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]169 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
170 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 },
172 ],
173 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]174 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
175 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
176 &quot;httpErrorStatusCode&quot;: 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.
177 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
178 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
179 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
180 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
181 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]186 <code class="details" id="close">close()</code>
187 <pre>Close httplib2 connections.</pre>
188</div>
189
190<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]191 <code class="details" id="delete">delete(project, deployment, deletePolicy=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192 <pre>Deletes a deployment and all of the resources in the deployment.
193
194Args:
195 project: string, The project ID for this request. (required)
196 deployment: string, The name of the deployment for this request. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]197 deletePolicy: string, Sets the policy to use for deleting resources.
198 Allowed values
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]199 DELETE -
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]200 ABANDON -
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205
206Returns:
207 An object of the form:
208
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]209 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]210 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]211 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]212 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]213 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]214 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
215 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]216 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
217 {
218 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]219 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]220 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
221 {
222 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
223 &quot;key&quot;: &quot;A String&quot;, # [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).
224 },
225 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]226 },
227 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]228 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
229 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
230 &quot;progress&quot;: 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.
231 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
232 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
233 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
234 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
236 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]237 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]238 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]239 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
240 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241 },
242 ],
243 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]244 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
245 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
246 &quot;httpErrorStatusCode&quot;: 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.
247 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
248 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
249 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
250 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
251 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 }</pre>
253</div>
254
255<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]256 <code class="details" id="get">get(project, deployment, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]257 <pre>Gets information about a specific deployment.
258
259Args:
260 project: string, The project ID for this request. (required)
261 deployment: string, The name of the deployment for this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]266
267Returns:
268 An object of the form:
269
270 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]271 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]272 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]273 { # Label object for DeploymentUpdate
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]274 &quot;key&quot;: &quot;A String&quot;, # Key of the label
275 &quot;value&quot;: &quot;A String&quot;, # Value of the label
276 },
277 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]278 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
279 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
280 },
281 &quot;id&quot;: &quot;A String&quot;,
282 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
283 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
284 &quot;name&quot;: &quot;A String&quot;, # 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.
285 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
286 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
287 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
288 &quot;imports&quot;: [ # 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.
289 {
290 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
291 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
292 },
293 ],
294 &quot;config&quot;: { # The configuration to use for this deployment.
295 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
296 },
297 },
298 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
299 &quot;fingerprint&quot;: &quot;A String&quot;, # 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. 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.
300 &quot;operation&quot;: { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
301 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
302 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
303 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
304 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
305 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
306 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
307 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
308 {
309 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
310 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
311 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]312 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]313 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
314 &quot;key&quot;: &quot;A String&quot;, # [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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]315 },
316 ],
317 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]318 ],
319 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
320 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
321 &quot;progress&quot;: 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.
322 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
323 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
324 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
325 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
326 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
327 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
328 {
329 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
330 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
331 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]332 },
333 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]334 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]335 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
336 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
337 &quot;httpErrorStatusCode&quot;: 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.
338 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
339 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
340 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
341 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
342 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
343 },
344 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
345 { # Label object for Deployments
346 &quot;key&quot;: &quot;A String&quot;, # Key of the label
347 &quot;value&quot;: &quot;A String&quot;, # Value of the label
348 },
349 ],
350 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]351</div>
352
353<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]354 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]355 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
356
357Args:
358 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 resource: string, Name or id of the resource for this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]360 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]365
366Returns:
367 An object of the form:
368
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]369 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]370 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]371 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]372 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]373 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]374 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]375 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]376 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]377 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]378 },
379 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]380 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]381 },
382 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]383 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]384 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]385 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
386 { # Associates `members` with a `role`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]387 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]388 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
389 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
390 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
391 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
392 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
393 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]394 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
395 &quot;A String&quot;,
396 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]397 },
398 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]399 }</pre>
400</div>
401
402<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]403 <code class="details" id="insert">insert(project, body=None, preview=None, createPolicy=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]404 <pre>Creates a deployment and all of the resources described by the deployment manifest.
405
406Args:
407 project: string, The project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]408 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]409 The object takes the form of:
410
411{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]412 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]413 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]414 { # Label object for DeploymentUpdate
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]415 &quot;key&quot;: &quot;A String&quot;, # Key of the label
416 &quot;value&quot;: &quot;A String&quot;, # Value of the label
417 },
418 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]419 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
420 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
421 },
422 &quot;id&quot;: &quot;A String&quot;,
423 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
424 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
425 &quot;name&quot;: &quot;A String&quot;, # 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.
426 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
427 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
428 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
429 &quot;imports&quot;: [ # 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.
430 {
431 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
432 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
433 },
434 ],
435 &quot;config&quot;: { # The configuration to use for this deployment.
436 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
437 },
438 },
439 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
440 &quot;fingerprint&quot;: &quot;A String&quot;, # 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. 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.
441 &quot;operation&quot;: { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
442 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
443 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
444 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
445 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
446 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
447 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
448 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
449 {
450 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
451 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
452 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]453 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]454 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
455 &quot;key&quot;: &quot;A String&quot;, # [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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]456 },
457 ],
458 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]459 ],
460 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
461 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
462 &quot;progress&quot;: 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.
463 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
464 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
465 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
466 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
467 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
468 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
469 {
470 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
471 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
472 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]473 },
474 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]475 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]476 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
477 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
478 &quot;httpErrorStatusCode&quot;: 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.
479 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
480 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
481 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
482 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
483 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
484 },
485 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
486 { # Label object for Deployments
487 &quot;key&quot;: &quot;A String&quot;, # Key of the label
488 &quot;value&quot;: &quot;A String&quot;, # Value of the label
489 },
490 ],
491}
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]492
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]493 preview: boolean, If set to true, creates a deployment and creates &quot;shell&quot; 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 createPolicy: string, Sets the policy to use for creating new resources.
495 Allowed values
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 CREATE_OR_ACQUIRE -
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]497 ACQUIRE -
498 x__xgafv: string, V1 error format.
499 Allowed values
500 1 - v1 error format
501 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]502
503Returns:
504 An object of the form:
505
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]506 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]507 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]508 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]509 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]510 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]511 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
512 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]513 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
514 {
515 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]516 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]517 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
518 {
519 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
520 &quot;key&quot;: &quot;A String&quot;, # [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).
521 },
522 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]523 },
524 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]525 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
526 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
527 &quot;progress&quot;: 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.
528 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
529 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
530 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
531 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]532 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
533 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]534 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]535 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]536 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
537 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]538 },
539 ],
540 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]541 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
542 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
543 &quot;httpErrorStatusCode&quot;: 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.
544 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
545 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
546 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
547 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
548 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]549 }</pre>
550</div>
551
552<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]553 <code class="details" id="list">list(project, returnPartialSuccess=None, filter=None, orderBy=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]554 <pre>Lists all deployments for a given project.
555
556Args:
557 project: string, The project ID for this request. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]558 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]559 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]560 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
561 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.
562 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. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]563 x__xgafv: string, V1 error format.
564 Allowed values
565 1 - v1 error format
566 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]567
568Returns:
569 An object of the form:
570
571 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]572 &quot;deployments&quot;: [ # Output only. The deployments contained in this response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]573 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]574 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]575 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]576 { # Label object for DeploymentUpdate
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]577 &quot;key&quot;: &quot;A String&quot;, # Key of the label
578 &quot;value&quot;: &quot;A String&quot;, # Value of the label
579 },
580 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]581 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
582 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
583 },
584 &quot;id&quot;: &quot;A String&quot;,
585 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
586 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
587 &quot;name&quot;: &quot;A String&quot;, # 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.
588 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
589 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
590 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
591 &quot;imports&quot;: [ # 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.
592 {
593 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
594 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
595 },
596 ],
597 &quot;config&quot;: { # The configuration to use for this deployment.
598 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
599 },
600 },
601 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
602 &quot;fingerprint&quot;: &quot;A String&quot;, # 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. 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.
603 &quot;operation&quot;: { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
604 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
605 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
606 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
607 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
608 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
609 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
610 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
611 {
612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
613 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
614 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]615 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]616 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
617 &quot;key&quot;: &quot;A String&quot;, # [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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]618 },
619 ],
620 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]621 ],
622 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
623 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
624 &quot;progress&quot;: 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.
625 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
626 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
627 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
628 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
629 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
630 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
631 {
632 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
633 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
634 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]635 },
636 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]637 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]638 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
639 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
640 &quot;httpErrorStatusCode&quot;: 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.
641 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
642 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
643 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
644 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
645 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]646 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]647 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
648 { # Label object for Deployments
649 &quot;key&quot;: &quot;A String&quot;, # Key of the label
650 &quot;value&quot;: &quot;A String&quot;, # Value of the label
651 },
652 ],
653 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]654 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]655 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token used to continue a truncated list request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]656 }</pre>
657</div>
658
659<div class="method">
660 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
661 <pre>Retrieves the next page of results.
662
663Args:
664 previous_request: The request for the previous page. (required)
665 previous_response: The response from the request for the previous page. (required)
666
667Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]668 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]669 page. Returns None if there are no more items in the collection.
670 </pre>
671</div>
672
673<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]674 <code class="details" id="patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]675 <pre>Patches a deployment and all of the resources described by the deployment manifest.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]676
677Args:
678 project: string, The project ID for this request. (required)
679 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]680 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]681 The object takes the form of:
682
683{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]684 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]685 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]686 { # Label object for DeploymentUpdate
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]687 &quot;key&quot;: &quot;A String&quot;, # Key of the label
688 &quot;value&quot;: &quot;A String&quot;, # Value of the label
689 },
690 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]691 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
692 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
693 },
694 &quot;id&quot;: &quot;A String&quot;,
695 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
696 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
697 &quot;name&quot;: &quot;A String&quot;, # 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.
698 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
699 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
700 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
701 &quot;imports&quot;: [ # 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.
702 {
703 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
704 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
705 },
706 ],
707 &quot;config&quot;: { # The configuration to use for this deployment.
708 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
709 },
710 },
711 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
712 &quot;fingerprint&quot;: &quot;A String&quot;, # 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. 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.
713 &quot;operation&quot;: { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
714 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
715 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
716 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
717 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
718 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
719 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
720 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
721 {
722 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
723 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
724 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]725 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]726 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
727 &quot;key&quot;: &quot;A String&quot;, # [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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]728 },
729 ],
730 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]731 ],
732 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
733 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
734 &quot;progress&quot;: 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.
735 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
736 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
737 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
738 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
739 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
740 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
741 {
742 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
743 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
744 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]745 },
746 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]747 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]748 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
749 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
750 &quot;httpErrorStatusCode&quot;: 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.
751 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
752 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
753 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
754 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
755 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
756 },
757 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
758 { # Label object for Deployments
759 &quot;key&quot;: &quot;A String&quot;, # Key of the label
760 &quot;value&quot;: &quot;A String&quot;, # Value of the label
761 },
762 ],
763}
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]764
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]765 createPolicy: string, Sets the policy to use for creating new resources.
766 Allowed values
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]767 CREATE_OR_ACQUIRE -
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]768 ACQUIRE -
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]769 deletePolicy: string, Sets the policy to use for deleting resources.
770 Allowed values
771 DELETE -
772 ABANDON -
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]773 preview: boolean, If set to true, updates the deployment and creates and updates the &quot;shell&quot; 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]774 x__xgafv: string, V1 error format.
775 Allowed values
776 1 - v1 error format
777 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]778
779Returns:
780 An object of the form:
781
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]782 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]783 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]784 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]785 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]786 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]787 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
788 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]789 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
790 {
791 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]792 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]793 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
794 {
795 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
796 &quot;key&quot;: &quot;A String&quot;, # [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).
797 },
798 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]799 },
800 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]801 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
802 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
803 &quot;progress&quot;: 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.
804 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
805 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
806 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
807 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]808 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
809 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]810 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]811 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]812 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
813 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]814 },
815 ],
816 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]817 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
818 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
819 &quot;httpErrorStatusCode&quot;: 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.
820 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
821 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
822 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
823 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
824 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]825 }</pre>
826</div>
827
828<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]829 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]830 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
831
832Args:
833 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]834 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]835 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]836 The object takes the form of:
837
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]838{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]839 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify bindings.
840 { # Associates `members` with a `role`.
841 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
842 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
843 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
844 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
845 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
846 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
847 },
848 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
849 &quot;A String&quot;,
850 ],
851 },
852 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]853 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify the etag.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]854 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]855 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]856 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]857 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]858 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]859 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]860 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]861 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]862 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]863 },
864 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]865 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]866 },
867 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]868 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]869 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]870 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
871 { # Associates `members` with a `role`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]872 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]873 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
874 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
875 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
876 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
877 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
878 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]879 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
880 &quot;A String&quot;,
881 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]882 },
883 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]884 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]885 }
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]886
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]887 x__xgafv: string, V1 error format.
888 Allowed values
889 1 - v1 error format
890 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]891
892Returns:
893 An object of the form:
894
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]895 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]896 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]897 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]898 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]899 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]900 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]901 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]902 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]903 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]904 },
905 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]906 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]907 },
908 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]909 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]910 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]911 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
912 { # Associates `members` with a `role`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]913 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]914 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
915 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
916 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
917 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
918 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
919 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]920 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
921 &quot;A String&quot;,
922 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]923 },
924 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]925 }</pre>
926</div>
927
928<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]929 <code class="details" id="stop">stop(project, deployment, body=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]930 <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.
931
932Args:
933 project: string, The project ID for this request. (required)
934 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]935 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]936 The object takes the form of:
937
938{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]939 &quot;fingerprint&quot;: &quot;A String&quot;, # 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). 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]940 }
941
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]942 x__xgafv: string, V1 error format.
943 Allowed values
944 1 - v1 error format
945 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]946
947Returns:
948 An object of the form:
949
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]950 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]951 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]952 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]953 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]954 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]955 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
956 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]957 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
958 {
959 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]960 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]961 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
962 {
963 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
964 &quot;key&quot;: &quot;A String&quot;, # [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).
965 },
966 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]967 },
968 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]969 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
970 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
971 &quot;progress&quot;: 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.
972 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
973 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
974 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
975 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]976 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
977 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]978 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]979 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]980 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
981 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]982 },
983 ],
984 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]985 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
986 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
987 &quot;httpErrorStatusCode&quot;: 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.
988 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
989 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
990 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
991 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
992 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]993 }</pre>
994</div>
995
996<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]997 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]998 <pre>Returns permissions that a caller has on the specified resource.
999
1000Args:
1001 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1002 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1003 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1004 The object takes the form of:
1005
1006{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1007 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1008 &quot;A String&quot;,
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1009 ],
1010 }
1011
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1012 x__xgafv: string, V1 error format.
1013 Allowed values
1014 1 - v1 error format
1015 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1016
1017Returns:
1018 An object of the form:
1019
1020 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1021 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1022 &quot;A String&quot;,
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1023 ],
1024 }</pre>
1025</div>
1026
1027<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1028 <code class="details" id="update">update(project, deployment, body=None, createPolicy=None, preview=None, deletePolicy=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1029 <pre>Updates a deployment and all of the resources described by the deployment manifest.
1030
1031Args:
1032 project: string, The project ID for this request. (required)
1033 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1034 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1035 The object takes the form of:
1036
1037{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1038 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1039 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1040 { # Label object for DeploymentUpdate
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1041 &quot;key&quot;: &quot;A String&quot;, # Key of the label
1042 &quot;value&quot;: &quot;A String&quot;, # Value of the label
1043 },
1044 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1045 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
1046 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
1047 },
1048 &quot;id&quot;: &quot;A String&quot;,
1049 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
1050 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
1051 &quot;name&quot;: &quot;A String&quot;, # 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.
1052 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
1053 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
1054 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
1055 &quot;imports&quot;: [ # 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.
1056 {
1057 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
1058 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
1059 },
1060 ],
1061 &quot;config&quot;: { # The configuration to use for this deployment.
1062 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
1063 },
1064 },
1065 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
1066 &quot;fingerprint&quot;: &quot;A String&quot;, # 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. 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.
1067 &quot;operation&quot;: { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
1068 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1069 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1070 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1071 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1072 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1073 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1074 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1075 {
1076 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1077 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1078 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1079 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1080 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1081 &quot;key&quot;: &quot;A String&quot;, # [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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1082 },
1083 ],
1084 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1085 ],
1086 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1087 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1088 &quot;progress&quot;: 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.
1089 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1090 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1091 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1092 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1093 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1094 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
1095 {
1096 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1097 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1098 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1099 },
1100 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1101 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1102 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1103 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1104 &quot;httpErrorStatusCode&quot;: 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.
1105 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1106 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1107 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1108 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1109 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1110 },
1111 &quot;labels&quot;: [ # Map of One Platform 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])?)?`.
1112 { # Label object for Deployments
1113 &quot;key&quot;: &quot;A String&quot;, # Key of the label
1114 &quot;value&quot;: &quot;A String&quot;, # Value of the label
1115 },
1116 ],
1117}
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1118
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1119 createPolicy: string, Sets the policy to use for creating new resources.
1120 Allowed values
1121 CREATE_OR_ACQUIRE -
1122 ACQUIRE -
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1123 preview: boolean, If set to true, updates the deployment and creates and updates the &quot;shell&quot; 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1124 deletePolicy: string, Sets the policy to use for deleting resources.
1125 Allowed values
1126 DELETE -
1127 ABANDON -
1128 x__xgafv: string, V1 error format.
1129 Allowed values
1130 1 - v1 error format
1131 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1132
1133Returns:
1134 An object of the form:
1135
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1136 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1137 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1138 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1139 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1140 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1141 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1142 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1143 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1144 {
1145 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1146 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1147 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
1148 {
1149 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1150 &quot;key&quot;: &quot;A String&quot;, # [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).
1151 },
1152 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1153 },
1154 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1155 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1156 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1157 &quot;progress&quot;: 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.
1158 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1159 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1160 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1161 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1162 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1163 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1164 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1165 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1166 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1167 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1168 },
1169 ],
1170 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1171 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1172 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1173 &quot;httpErrorStatusCode&quot;: 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.
1174 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1175 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1176 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1177 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1178 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1179 }</pre>
1180</div>
1181
1182</body></html>