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