Debian Codegraph @

docs/dyn/containeranalysis_v1alpha1.projects.operations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new `Operation`.</p>
83 <p class="toc_element">
84 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
94 <pre>Creates a new `Operation`.
95
96 Args:
97 parent: string, The project Id that this operation should be created under. (required)
98 body: object, The request body.
99 The object takes the form of:
100
101 { # Request for creating an operation
102 &quot;operation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # The operation to create.
103 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
104 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
105 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
106 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
107 {
108 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
109 },
110 ],
111 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
112 },
113 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a 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 },
116 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
117 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
118 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
119 },
120 },
121 &quot;operationId&quot;: &quot;A String&quot;, # The ID to use for this operation.
122 }
123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # This resource represents a long-running operation that is the result of a network API call.
133 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
134 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
135 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
136 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
137 {
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 ],
141 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
142 },
143 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
144 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
145 },
146 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
147 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
155 <pre>Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.
156
157 Args:
158 name: string, The name of the Operation. Should be of the form &quot;projects/{provider_id}/operations/{operation_id}&quot;. (required)
159 body: object, The request body.
160 The object takes the form of:
161
162 { # Request for updating an existing operation
163 &quot;operation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # The operation to create.
164 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
165 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
166 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
167 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
168 {
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
171 ],
172 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
173 },
174 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
177 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
178 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 },
182 &quot;updateMask&quot;: &quot;A String&quot;, # The fields to update.
183 }
184
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 { # This resource represents a long-running operation that is the result of a network API call.
194 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
195 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
196 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
197 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
198 {
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 ],
202 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
203 },
204 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
206 },
207 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
208 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
211 }</pre>
212 </div>
213
214 </body></html>