Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / container_v1.projects.locations.operations.html
blob: 47ae4e35b77f6782f4cf9840b2139d4f581bc785 [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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]84 <code><a href="#get">get(name, operationId=None, projectId=None, zone=None, x__xgafv=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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]87 <code><a href="#list">list(parent, projectId=None, zone=None, x__xgafv=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 Bot0d561ef2020-11-25 07:50:41 -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/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]101 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]102 &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.
103 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 }
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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 }</pre>
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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]124 <code class="details" id="get">get(name, operationId=None, projectId=None, zone=None, x__xgafv=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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]131 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]132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]141 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
142 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]143 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]144 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]145 },
146 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]147 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]148 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]149 &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}]
150 { # Progress metric is (string, int|float|string) pair.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]151 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]152 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
153 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]154 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
155 },
156 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]157 &quot;stages&quot;: [ # Substages of an operation or a stage.
158 # Object with schema name: OperationProgress
159 ],
160 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
161 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]162 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]163 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
164 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
165 &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.
166 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]167 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]168 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
169 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
170 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
171 &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.
172 &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.
173 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
174 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
175 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
176 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
177 },
178 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 }</pre>
180</div>
181
182<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]183 <code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]189 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]190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195Returns:
196 An object of the form:
197
198 { # ListOperationsResponse is the result of ListOperationsRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;operations&quot;: [ # A list of operations in the project in the specified zone.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]200 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]201 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
202 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]203 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]204 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]205 },
206 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]207 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]208 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]209 &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}]
210 { # Progress metric is (string, int|float|string) pair.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]211 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]212 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
213 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]214 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
215 },
216 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]217 &quot;stages&quot;: [ # Substages of an operation or a stage.
218 # Object with schema name: OperationProgress
219 ],
220 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
221 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]222 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]223 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
224 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
225 &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.
226 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]227 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]228 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
229 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
230 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
231 &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.
232 &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.
233 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
234 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
235 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
236 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
237 },
238 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 },
240 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]241 &quot;missingZones&quot;: [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
242 &quot;A String&quot;,
243 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 }</pre>
245</div>
246
247</body></html>