Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / containeranalysis_v1alpha1.projects.operations.html
blob: 3b7d61b319aaa71e71da566fc6be84b209f9e204 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
75<h1><a href="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.projects.html">projects</a> . <a href="containeranalysis_v1alpha1.projects.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a new `Operation`.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Updates an existing operation returns an error if operation</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>Creates a new `Operation`.
87
88Args:
89 parent: string, The project Id that this operation should be created under. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 The object takes the form of:
92
93{ # Request for creating an operation
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94 &quot;operationId&quot;: &quot;A String&quot;, # The ID to use for this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 &quot;operation&quot;: { # This resource represents a long-running operation that is the result of a # The operation to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 # method returns no data on success, such as `Delete`, the response is
99 # `google.protobuf.Empty`. If the original method is standard
100 # `Get`/`Create`/`Update`, the response should be the resource. For other
101 # methods, the response should have the type `XxxResponse`, where `Xxx`
102 # is the original method name. For example, if the original method name
103 # is `TakeSnapshot()`, the inferred response type is
104 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]107 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
108 # originally returns it. If you use the default HTTP mapping, the
109 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
111 # contains progress information and common metadata such as create time.
112 # Some services might not provide such metadata. Any method that returns a
113 # long-running operation should document the metadata type, if any.
114 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
115 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]116 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
117 # different programming environments, including REST APIs and RPC APIs. It is
118 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
119 # three pieces of data: error code, error message, and error details.
120 #
121 # You can find out more about this error model and how to work with it in the
122 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
124 # user-facing error message should be localized and sent in the
125 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]126 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
127 # message types for APIs to use.
128 {
129 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130 },
131 ],
132 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]133 },
134 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
135 # If `true`, the operation is completed, and either `error` or `response` is
136 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # This resource represents a long-running operation that is the result of a
149 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 # method returns no data on success, such as `Delete`, the response is
152 # `google.protobuf.Empty`. If the original method is standard
153 # `Get`/`Create`/`Update`, the response should be the resource. For other
154 # methods, the response should have the type `XxxResponse`, where `Xxx`
155 # is the original method name. For example, if the original method name
156 # is `TakeSnapshot()`, the inferred response type is
157 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
161 # originally returns it. If you use the default HTTP mapping, the
162 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
164 # contains progress information and common metadata such as create time.
165 # Some services might not provide such metadata. Any method that returns a
166 # long-running operation should document the metadata type, if any.
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
170 # different programming environments, including REST APIs and RPC APIs. It is
171 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
172 # three pieces of data: error code, error message, and error details.
173 #
174 # You can find out more about this error model and how to work with it in the
175 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
177 # user-facing error message should be localized and sent in the
178 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]179 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
180 # message types for APIs to use.
181 {
182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
183 },
184 ],
185 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]186 },
187 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
188 # If `true`, the operation is completed, and either `error` or `response` is
189 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 }</pre>
191</div>
192
193<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]194 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 <pre>Updates an existing operation returns an error if operation
196 does not exist. The only valid operations are to update mark the done bit
197change the result.
198
199Args:
200 name: string, The name of the Operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201Should be of the form &quot;projects/{provider_id}/operations/{operation_id}&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]202 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 The object takes the form of:
204
205{ # Request for updating an existing operation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;operation&quot;: { # This resource represents a long-running operation that is the result of a # The operation to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 # method returns no data on success, such as `Delete`, the response is
210 # `google.protobuf.Empty`. If the original method is standard
211 # `Get`/`Create`/`Update`, the response should be the resource. For other
212 # methods, the response should have the type `XxxResponse`, where `Xxx`
213 # is the original method name. For example, if the original method name
214 # is `TakeSnapshot()`, the inferred response type is
215 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]218 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
219 # originally returns it. If you use the default HTTP mapping, the
220 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]221 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
222 # contains progress information and common metadata such as create time.
223 # Some services might not provide such metadata. Any method that returns a
224 # long-running operation should document the metadata type, if any.
225 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
226 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]227 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
228 # different programming environments, including REST APIs and RPC APIs. It is
229 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
230 # three pieces of data: error code, error message, and error details.
231 #
232 # You can find out more about this error model and how to work with it in the
233 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]234 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
235 # user-facing error message should be localized and sent in the
236 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
238 # message types for APIs to use.
239 {
240 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
241 },
242 ],
243 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]244 },
245 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
246 # If `true`, the operation is completed, and either `error` or `response` is
247 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]249 &quot;updateMask&quot;: &quot;A String&quot;, # The fields to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 }
251
252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
260 { # This resource represents a long-running operation that is the result of a
261 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 # method returns no data on success, such as `Delete`, the response is
264 # `google.protobuf.Empty`. If the original method is standard
265 # `Get`/`Create`/`Update`, the response should be the resource. For other
266 # methods, the response should have the type `XxxResponse`, where `Xxx`
267 # is the original method name. For example, if the original method name
268 # is `TakeSnapshot()`, the inferred response type is
269 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]270 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]272 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
273 # originally returns it. If you use the default HTTP mapping, the
274 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]275 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
276 # contains progress information and common metadata such as create time.
277 # Some services might not provide such metadata. Any method that returns a
278 # long-running operation should document the metadata type, if any.
279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
280 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]281 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
282 # different programming environments, including REST APIs and RPC APIs. It is
283 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
284 # three pieces of data: error code, error message, and error details.
285 #
286 # You can find out more about this error model and how to work with it in the
287 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]288 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
289 # user-facing error message should be localized and sent in the
290 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]291 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
292 # message types for APIs to use.
293 {
294 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
295 },
296 ],
297 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]298 },
299 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
300 # If `true`, the operation is completed, and either `error` or `response` is
301 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 }</pre>
303</div>
304
305</body></html>