blob: 96833f897a2c06518c5fda5613fe6bc3a67a37ff [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.locations.html">locations</a> . <a href="container_v1beta1.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 -070078 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070084 <code><a href="#get">get(name, zone=None, projectId=None, operationId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Gets the specified operation.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#list">list(parent, zone=None, projectId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists all operations in a project in the specified zone or all zones.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070091 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 <pre>Cancels the specified operation.
93
94Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095 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 -070096 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097 The object takes the form of:
98
99{ # CancelOperationRequest cancels a single operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 &quot;operationId&quot;: &quot;A String&quot;, # Required. 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 -0700101 &quot;projectId&quot;: &quot;A String&quot;, # Required. 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 Botc2228be2020-11-24 15:48:03 -0800102 &quot;zone&quot;: &quot;A String&quot;, # Required. 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;name&quot;: &quot;A String&quot;, # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104 }
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 -0700114 { # 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 -0700115 }</pre>
116</div>
117
118<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 <code class="details" id="close">close()</code>
120 <pre>Close httplib2 connections.</pre>
121</div>
122
123<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700124 <code class="details" id="get">get(name, zone=None, projectId=None, operationId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 <pre>Gets the specified operation.
126
127Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700128 name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 zone: string, Required. 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 Kim673ec5c2020-11-16 11:05:03 -0700130 projectId: string, Required. 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.
131 operationId: string, Required. 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 -0700132 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 -0700136
137Returns:
138 An object of the form:
139
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
141 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800142 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700143 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800144 &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.
145 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700146 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700147 &quot;stages&quot;: [ # Substages of an operation or a stage.
148 # Object with schema name: OperationProgress
149 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800150 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
151 &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}]
152 { # Progress metric is (string, int|float|string) pair.
153 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
154 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
155 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
156 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
157 },
158 ],
159 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700161 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
162 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700163 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700164 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800165 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700166 },
167 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800168 &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.
169 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700171 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
174 {
175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
177 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700178 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800179 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
180 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
181 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
182 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
183 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
184 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
185 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
186 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
187 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
188 },
189 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700190 }</pre>
191</div>
192
193<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700194 <code class="details" id="list">list(parent, zone=None, projectId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700195 <pre>Lists all operations in a project in the specified zone or all zones.
196
197Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 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)
199 zone: string, Required. 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.
200 projectId: string, Required. 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 -0700201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # ListOperationsResponse is the result of ListOperationsRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 &quot;operations&quot;: [ # A list of operations in the project in the specified zone.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700211 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
212 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800213 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700214 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800215 &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.
216 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700217 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700218 &quot;stages&quot;: [ # Substages of an operation or a stage.
219 # Object with schema name: OperationProgress
220 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800221 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
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;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
225 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
226 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
227 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
228 },
229 ],
230 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
233 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700235 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800236 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700237 },
238 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800239 &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.
240 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700241 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700242 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
243 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
245 {
246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
247 },
248 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800250 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
251 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
252 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
253 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
254 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
255 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
256 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
257 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
258 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
259 },
260 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700261 },
262 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700263 &quot;missingZones&quot;: [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
264 &quot;A String&quot;,
265 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 }</pre>
267</div>
268
269</body></html>