Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f6c78a8b24c6fd6a8207f72ea778195836bb543d / . / docs / dyn / container_v1.projects.locations.operations.html
blob: b6220f1c7f33c48b359bc22204a3e20285b6bd8e [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="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.locations.html">locations</a> . <a href="container_v1.projects.locations.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="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Cancels the specified operation.</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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]84 <code><a href="#get">get(name, operationId=None, projectId=None, x__xgafv=None, zone=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Gets the specified operation.</p>
86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]87 <code><a href="#list">list(parent, projectId=None, x__xgafv=None, zone=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists all operations in a project in a specific zone or all zones.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <pre>Cancels the specified operation.
93
94Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]95 name: string, The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 The object takes the form of:
98
99{ # CancelOperationRequest cancels a single operation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]100 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
101 &quot;operationId&quot;: &quot;A String&quot;, # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
102 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
103 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
104}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]115}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116</div>
117
118<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 <code class="details" id="close">close()</code>
120 <pre>Close httplib2 connections.</pre>
121</div>
122
123<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]124 <code class="details" id="get">get(name, operationId=None, projectId=None, x__xgafv=None, zone=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 <pre>Gets the specified operation.
126
127Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]130 projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135 zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
137Returns:
138 An object of the form:
139
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]141 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
142 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
143 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
144 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]145 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]146 ],
147 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
148 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
149 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
150 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
151 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
152 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
153 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
154 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
155 },
156 ],
157 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
158 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
159 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
160 { # Progress metric is (string, int|float|string) pair.
161 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
162 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
163 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
164 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]165 },
166 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]167 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
168 &quot;stages&quot;: [ # Substages of an operation or a stage.
169 # Object with schema name: OperationProgress
170 ],
171 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
172 },
173 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
174 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
175 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
176 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
177 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
178 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
179}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180</div>
181
182<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]183 <code class="details" id="list">list(parent, projectId=None, x__xgafv=None, zone=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 <pre>Lists all operations in a project in a specific zone or all zones.
185
186Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]187 parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location &quot;-&quot; matches all zones and all regions. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]188 projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]193 zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194
195Returns:
196 An object of the form:
197
198 { # ListOperationsResponse is the result of ListOperationsRequest.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]199 &quot;missingZones&quot;: [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
200 &quot;A String&quot;,
201 ],
202 &quot;operations&quot;: [ # A list of operations in the project in the specified zone.
203 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
204 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
205 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
206 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
207 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]208 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]209 ],
210 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
211 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
212 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
213 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
214 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
215 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
216 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
217 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
218 },
219 ],
220 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
221 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
222 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
223 { # Progress metric is (string, int|float|string) pair.
224 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
225 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
226 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
227 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]228 },
229 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]230 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
231 &quot;stages&quot;: [ # Substages of an operation or a stage.
232 # Object with schema name: OperationProgress
233 ],
234 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]236 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
237 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
238 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
239 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
240 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
241 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
242 },
243 ],
244}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245</div>
246
247</body></html>