Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / deploymentmanager_v2beta.deployments.html
blob: 98f0ad40ff12a821d15ee1f2e36143f324cb4568 [file] [log] [blame]
Sai Cheemalapatie833b792017-03-24 15:06:46 -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_v2beta.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_v2beta.deployments.html">deployments</a></h1>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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 Cheemalapatie833b792017-03-24 15:06:46 -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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]93 <code><a href="#insert">insert(project, body=None, preview=None, createPolicy=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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, orderBy=None, maxResults=None, filter=None, returnPartialSuccess=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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, deletePolicy=None, preview=None, createPolicy=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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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 Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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 Cheemalapatie833b792017-03-24 15:06:46 -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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]114 <code><a href="#update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -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
Sai Cheemalapatie833b792017-03-24 15:06:46 -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;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
141 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]142 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
143 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]144 &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^]145 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]146 &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; }
147 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]148 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]149 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]150 },
151 ],
152 },
153 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]154 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]155 &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^]156 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
157 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]158 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]159 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]160 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]161 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
162 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
163 &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.
164 &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.
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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]167 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]168 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]169 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]170 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]171 },
172 ],
173 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]174 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
175 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
176 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
177 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]178 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]179 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
180 &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.
181 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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)
197 deletePolicy: string, Sets the policy to use for deleting resources.
198 Allowed values
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[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
Sai Cheemalapatie833b792017-03-24 15:06:46 -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;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
211 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]212 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
213 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]214 &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^]215 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]216 &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; }
217 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]218 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]219 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]220 },
221 ],
222 },
223 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]224 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]225 &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^]226 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
227 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]228 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]229 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]230 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]231 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
232 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
233 &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.
234 &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.
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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]237 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]238 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]239 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]240 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]241 },
242 ],
243 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]244 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
245 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
246 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
247 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]248 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]249 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
250 &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.
251 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -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>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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
Sai Cheemalapatie833b792017-03-24 15:06:46 -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.
272 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
273 &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])?)?`.
274 { # Label object for DeploymentUpdate
275 &quot;key&quot;: &quot;A String&quot;, # Key of the label
276 &quot;value&quot;: &quot;A String&quot;, # Value of the label
277 },
278 ],
279 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
280 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]281 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]282 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
283 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
284 &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.
285 &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.
286 &quot;id&quot;: &quot;A String&quot;,
287 &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.
288 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
289 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
290 &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.
291 {
292 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
293 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
294 },
295 ],
296 &quot;config&quot;: { # The configuration to use for this deployment.
297 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
298 },
299 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]300 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]301 { # Label object for Deployments
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]302 &quot;value&quot;: &quot;A String&quot;, # Value of the label
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]303 &quot;key&quot;: &quot;A String&quot;, # Key of the label
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]304 },
305 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]306 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]307 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
308 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]309 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
310 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]311 &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^]312 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]313 &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; }
314 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]315 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]316 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]317 },
318 ],
319 },
320 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]321 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]322 &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^]323 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
324 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]325 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]326 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]327 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]328 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
329 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
330 &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.
331 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]332 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
333 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]334 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]335 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]336 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
337 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]338 },
339 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]340 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]341 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
342 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
343 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
344 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]345 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]346 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
347 &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.
348 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]349 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]350 }</pre>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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 Cheemalapatie833b792017-03-24 15:06:46 -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 Cheemalapatie833b792017-03-24 15:06:46 -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/).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]370 &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.
371 { # Associates `members` with a `role`.
372 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
373 &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`.
374 &quot;A String&quot;,
375 ],
376 &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).
377 &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.
378 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
379 &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.
380 &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.
381 },
382 },
383 ],
Yoshi Automation Botb6971b02020-11-26 17:16: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).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]385 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]386 { # 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.
387 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]388 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]389 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]390 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]391 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]392 &quot;A String&quot;,
393 ],
394 },
395 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]396 },
397 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]398 &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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]399 }</pre>
400</div>
401
402<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]403 <code class="details" id="insert">insert(project, body=None, preview=None, createPolicy=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -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.
413 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
414 &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])?)?`.
415 { # Label object for DeploymentUpdate
416 &quot;key&quot;: &quot;A String&quot;, # Key of the label
417 &quot;value&quot;: &quot;A String&quot;, # Value of the label
418 },
419 ],
420 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
421 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]422 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]423 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
424 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
425 &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.
426 &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.
427 &quot;id&quot;: &quot;A String&quot;,
428 &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.
429 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
430 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
431 &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.
432 {
433 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
434 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
435 },
436 ],
437 &quot;config&quot;: { # The configuration to use for this deployment.
438 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
439 },
440 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]441 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]442 { # Label object for Deployments
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]443 &quot;value&quot;: &quot;A String&quot;, # Value of the label
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]444 &quot;key&quot;: &quot;A String&quot;, # Key of the label
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]445 },
446 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]447 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]448 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
449 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]450 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
451 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]452 &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^]453 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]454 &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; }
455 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]456 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]457 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]458 },
459 ],
460 },
461 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]462 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]463 &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^]464 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
465 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]466 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]467 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]468 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]469 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
470 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
471 &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.
472 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]473 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
474 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]475 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]476 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]477 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]479 },
480 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]481 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]482 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
483 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
484 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
485 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]486 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]487 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
488 &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.
489 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]490 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]491 }
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]492
Yoshi Automation Bot0bf565c2020-12-09 08:56: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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]494 createPolicy: string, Sets the policy to use for creating new resources.
495 Allowed values
496 CREATE_OR_ACQUIRE -
497 ACQUIRE -
498 CREATE -
499 x__xgafv: string, V1 error format.
500 Allowed values
501 1 - v1 error format
502 2 - v2 error format
503
504Returns:
505 An object of the form:
506
507 { # 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^]508 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
509 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]510 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
511 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]512 &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^]513 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]514 &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; }
515 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]516 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]517 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]518 },
519 ],
520 },
521 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]522 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]523 &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^]524 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
525 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]526 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]527 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]528 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]529 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
530 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
531 &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.
532 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]533 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
534 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
535 {
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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]537 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]538 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]539 },
540 ],
541 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]542 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
543 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
544 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
545 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]546 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]547 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
548 &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.
549 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]550 }</pre>
551</div>
552
553<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]554 <code class="details" id="list">list(project, orderBy=None, maxResults=None, filter=None, returnPartialSuccess=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]555 <pre>Lists all deployments for a given project.
556
557Args:
558 project: string, The project ID for this request. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]559 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]560 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`)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]561 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) ```
562 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.
563 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]564 x__xgafv: string, V1 error format.
565 Allowed values
566 1 - v1 error format
567 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]568
569Returns:
570 An object of the form:
571
572 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]573 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token used to continue a truncated list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]574 &quot;deployments&quot;: [ # Output only. The deployments contained in this response.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]575 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]576 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
577 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
578 &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])?)?`.
579 { # Label object for DeploymentUpdate
580 &quot;key&quot;: &quot;A String&quot;, # Key of the label
581 &quot;value&quot;: &quot;A String&quot;, # Value of the label
582 },
583 ],
584 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
585 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]586 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]587 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
588 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
589 &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.
590 &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.
591 &quot;id&quot;: &quot;A String&quot;,
592 &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.
593 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
594 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
595 &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.
596 {
597 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
598 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
599 },
600 ],
601 &quot;config&quot;: { # The configuration to use for this deployment.
602 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
603 },
604 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]605 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]606 { # Label object for Deployments
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]607 &quot;value&quot;: &quot;A String&quot;, # Value of the label
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]608 &quot;key&quot;: &quot;A String&quot;, # Key of the label
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]609 },
610 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]611 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]612 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
613 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]614 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
615 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]616 &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^]617 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]618 &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; }
619 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]620 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]621 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]622 },
623 ],
624 },
625 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]626 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]627 &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^]628 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
629 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]630 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]631 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]632 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]633 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
634 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
635 &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.
636 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]637 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
638 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]639 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]640 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]641 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
642 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]643 },
644 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]645 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]646 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
647 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
648 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
649 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]650 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]651 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
652 &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.
653 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]654 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]655 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]656 ],
657 }</pre>
658</div>
659
660<div class="method">
661 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
662 <pre>Retrieves the next page of results.
663
664Args:
665 previous_request: The request for the previous page. (required)
666 previous_response: The response from the request for the previous page. (required)
667
668Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]669 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]670 page. Returns None if there are no more items in the collection.
671 </pre>
672</div>
673
674<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]675 <code class="details" id="patch">patch(project, deployment, body=None, deletePolicy=None, preview=None, createPolicy=None, x__xgafv=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]676 <pre>Patches a deployment and all of the resources described by the deployment manifest.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]677
678Args:
679 project: string, The project ID for this request. (required)
680 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]681 body: object, The request body.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]682 The object takes the form of:
683
684{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]685 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
686 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
687 &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])?)?`.
688 { # Label object for DeploymentUpdate
689 &quot;key&quot;: &quot;A String&quot;, # Key of the label
690 &quot;value&quot;: &quot;A String&quot;, # Value of the label
691 },
692 ],
693 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
694 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]695 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]696 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
697 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
698 &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.
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;id&quot;: &quot;A String&quot;,
701 &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.
702 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
703 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
704 &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.
705 {
706 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
707 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
708 },
709 ],
710 &quot;config&quot;: { # The configuration to use for this deployment.
711 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
712 },
713 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]714 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]715 { # Label object for Deployments
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]716 &quot;value&quot;: &quot;A String&quot;, # Value of the label
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]717 &quot;key&quot;: &quot;A String&quot;, # Key of the label
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]718 },
719 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]720 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]721 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
722 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]723 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
724 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]725 &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^]726 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]727 &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; }
728 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]729 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]730 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]731 },
732 ],
733 },
734 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]735 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]736 &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^]737 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
738 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]739 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]740 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]741 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]742 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
743 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
744 &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.
745 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]746 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
747 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]748 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]749 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]750 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
751 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]752 },
753 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]754 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]755 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
756 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
757 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
758 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]759 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]760 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
761 &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.
762 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]763 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]764 }
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]765
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]766 deletePolicy: string, Sets the policy to use for deleting resources.
767 Allowed values
768 DELETE -
769 ABANDON -
770 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]771 createPolicy: string, Sets the policy to use for creating new resources.
772 Allowed values
773 CREATE_OR_ACQUIRE -
774 ACQUIRE -
775 CREATE -
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]776 x__xgafv: string, V1 error format.
777 Allowed values
778 1 - v1 error format
779 2 - v2 error format
780
781Returns:
782 An object of the form:
783
784 { # 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^]785 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
786 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]787 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
788 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]789 &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^]790 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]791 &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; }
792 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]793 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]794 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]795 },
796 ],
797 },
798 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]799 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]800 &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^]801 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
802 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]803 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]804 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]805 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]806 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
807 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
808 &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.
809 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]810 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
811 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
812 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]813 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]814 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]815 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]816 },
817 ],
818 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]819 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
820 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
821 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
822 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]823 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]824 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
825 &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.
826 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]827 }</pre>
828</div>
829
830<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]831 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]832 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
833
834Args:
835 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]836 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]837 body: object, The request body.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]838 The object takes the form of:
839
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]840{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]841 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]842 &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.
843 { # Associates `members` with a `role`.
844 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
845 &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`.
846 &quot;A String&quot;,
847 ],
848 &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).
849 &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.
850 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
851 &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.
852 &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.
853 },
854 },
855 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]856 &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).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]857 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]858 { # 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.
859 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]860 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]861 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]862 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]863 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]864 &quot;A String&quot;,
865 ],
866 },
867 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]868 },
869 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]870 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]871 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]872 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify bindings.
873 { # Associates `members` with a `role`.
874 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]875 &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`.
876 &quot;A String&quot;,
877 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]878 &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).
879 &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.
880 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
881 &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.
882 &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.
883 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]884 },
885 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]886 &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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]887 }
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]888
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]889 x__xgafv: string, V1 error format.
890 Allowed values
891 1 - v1 error format
892 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]893
894Returns:
895 An object of the form:
896
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]897 { # 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/).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]898 &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.
899 { # Associates `members` with a `role`.
900 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
901 &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`.
902 &quot;A String&quot;,
903 ],
904 &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).
905 &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.
906 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
907 &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.
908 &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.
909 },
910 },
911 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]912 &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).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]913 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]914 { # 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.
915 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]916 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]917 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]918 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]919 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]920 &quot;A String&quot;,
921 ],
922 },
923 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]924 },
925 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]926 &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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]927 }</pre>
928</div>
929
930<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]931 <code class="details" id="stop">stop(project, deployment, body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]932 <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.
933
934Args:
935 project: string, The project ID for this request. (required)
936 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]937 body: object, The request body.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]938 The object takes the form of:
939
940{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]941 &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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]942 }
943
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]944 x__xgafv: string, V1 error format.
945 Allowed values
946 1 - v1 error format
947 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]948
949Returns:
950 An object of the form:
951
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]952 { # 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^]953 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
954 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]955 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
956 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]957 &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^]958 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]959 &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; }
960 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]961 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]962 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]963 },
964 ],
965 },
966 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]967 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]968 &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^]969 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
970 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]971 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]972 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]973 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]974 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
975 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
976 &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.
977 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]978 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
979 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]980 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]981 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]982 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]983 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]984 },
985 ],
986 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]987 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
988 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
989 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
990 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]991 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]992 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
993 &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.
994 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]995 }</pre>
996</div>
997
998<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]999 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1000 <pre>Returns permissions that a caller has on the specified resource.
1001
1002Args:
1003 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1004 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1005 body: object, The request body.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1006 The object takes the form of:
1007
1008{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1009 &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.
1010 &quot;A String&quot;,
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1011 ],
1012 }
1013
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1014 x__xgafv: string, V1 error format.
1015 Allowed values
1016 1 - v1 error format
1017 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1018
1019Returns:
1020 An object of the form:
1021
1022 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1023 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1024 &quot;A String&quot;,
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1025 ],
1026 }</pre>
1027</div>
1028
1029<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1030 <code class="details" id="update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1031 <pre>Updates a deployment and all of the resources described by the deployment manifest.
1032
1033Args:
1034 project: string, The project ID for this request. (required)
1035 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1036 body: object, The request body.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1037 The object takes the form of:
1038
1039{
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1040 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
1041 &quot;description&quot;: &quot;A String&quot;, # Output only. An optional user-provided description of the deployment after the current update has been applied.
1042 &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])?)?`.
1043 { # Label object for DeploymentUpdate
1044 &quot;key&quot;: &quot;A String&quot;, # Key of the label
1045 &quot;value&quot;: &quot;A String&quot;, # Value of the label
1046 },
1047 ],
1048 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this deployment.
1049 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1050 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1051 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
1052 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server defined URL for the resource.
1053 &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.
1054 &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.
1055 &quot;id&quot;: &quot;A String&quot;,
1056 &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.
1057 &quot;description&quot;: &quot;A String&quot;, # An optional user-provided description of the deployment.
1058 &quot;target&quot;: { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
1059 &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.
1060 {
1061 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
1062 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
1063 },
1064 ],
1065 &quot;config&quot;: { # The configuration to use for this deployment.
1066 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
1067 },
1068 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1069 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1070 { # Label object for Deployments
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1071 &quot;value&quot;: &quot;A String&quot;, # Value of the label
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1072 &quot;key&quot;: &quot;A String&quot;, # Key of the label
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1073 },
1074 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1075 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1076 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1077 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1078 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1079 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1080 &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^]1081 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1082 &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; }
1083 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1084 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1085 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1086 },
1087 ],
1088 },
1089 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1090 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1091 &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^]1092 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1093 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1094 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1095 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1096 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1097 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1098 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1099 &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.
1100 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1101 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1102 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1103 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1104 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1105 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1106 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1107 },
1108 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1109 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1110 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1111 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1112 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1113 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1114 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1115 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1116 &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.
1117 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1118 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1119 }
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1120
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1121 createPolicy: string, Sets the policy to use for creating new resources.
1122 Allowed values
1123 CREATE_OR_ACQUIRE -
1124 ACQUIRE -
1125 CREATE -
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1126 deletePolicy: string, Sets the policy to use for deleting resources.
1127 Allowed values
1128 DELETE -
1129 ABANDON -
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1130 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]1131 x__xgafv: string, V1 error format.
1132 Allowed values
1133 1 - v1 error format
1134 2 - v2 error format
1135
1136Returns:
1137 An object of the form:
1138
1139 { # 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^]1140 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1141 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1142 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1143 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1144 &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^]1145 &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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1146 &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; }
1147 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1148 &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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1149 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1150 },
1151 ],
1152 },
1153 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1154 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1155 &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^]1156 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1157 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1158 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1159 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1160 &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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1161 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1162 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1163 &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.
1164 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1165 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1166 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
1167 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1168 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1169 &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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1170 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1171 },
1172 ],
1173 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1174 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1175 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1176 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1177 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1178 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]1179 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1180 &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.
1181 &quot;kind&quot;: &quot;deploymentmanager#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1182 }</pre>
1183</div>
1184
1185</body></html>