| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.operations.html">operations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Cancels the specified operation.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(projectId, zone, operationId, name=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets the specified operation.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Lists all operations in a project in the specified zone or all zones.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <code class="details" id="cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <pre>Cancels the specified operation. |
| 90 | |
| 91 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 92 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | number](https://support.google.com/cloud/answer/6158840). |
| 94 | This field has been deprecated and replaced by the name field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 95 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 96 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 97 | operation resides. This field has been deprecated and replaced by the name |
| 98 | field. (required) |
| 99 | operationId: string, Required. Deprecated. The server-assigned `name` of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | This field has been deprecated and replaced by the name field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | The object takes the form of: |
| 103 | |
| 104 | { # CancelOperationRequest cancels a single operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 106 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 107 | # operation resides. This field has been deprecated and replaced by the name |
| 108 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 109 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 110 | # number](https://support.google.com/cloud/answer/6158840). |
| 111 | # This field has been deprecated and replaced by the name field. |
| 112 | "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. |
| 113 | # This field has been deprecated and replaced by the name field. |
| 114 | "name": "A String", # The name (project, location, operation id) of the operation to cancel. |
| 115 | # Specified in the format `projects/*/locations/*/operations/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | x__xgafv: string, V1 error format. |
| 119 | Allowed values |
| 120 | 1 - v1 error format |
| 121 | 2 - v2 error format |
| 122 | |
| 123 | Returns: |
| 124 | An object of the form: |
| 125 | |
| 126 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 127 | # empty messages in your APIs. A typical example is to use it as the request |
| 128 | # or the response type of an API method. For instance: |
| 129 | # |
| 130 | # service Foo { |
| 131 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 132 | # } |
| 133 | # |
| 134 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 135 | }</pre> |
| 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| 139 | <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code> |
| 140 | <pre>Gets the specified operation. |
| 141 | |
| 142 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 143 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 144 | number](https://support.google.com/cloud/answer/6158840). |
| 145 | This field has been deprecated and replaced by the name field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 146 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 147 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 148 | cluster resides. This field has been deprecated and replaced by the name |
| 149 | field. (required) |
| 150 | operationId: string, Required. Deprecated. The server-assigned `name` of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | This field has been deprecated and replaced by the name field. (required) |
| 152 | name: string, The name (project, location, operation id) of the operation to get. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | Specified in the format `projects/*/locations/*/operations/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 154 | x__xgafv: string, V1 error format. |
| 155 | Allowed values |
| 156 | 1 - v1 error format |
| 157 | 2 - v2 error format |
| 158 | |
| 159 | Returns: |
| 160 | An object of the form: |
| 161 | |
| 162 | { # This operation resource represents operations that may have happened or are |
| 163 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 164 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 165 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 167 | "stages": [ # Substages of an operation or a stage. |
| 168 | # Object with schema name: OperationProgress |
| 169 | ], |
| 170 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 171 | # Unset for single-stage operations. |
| 172 | "status": "A String", # Status of an operation stage. |
| 173 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "metrics": [ # Progress metric bundle, for example: |
| 175 | # metrics: [{name: "nodes done", int_value: 15}, |
| 176 | # {name: "nodes total", int_value: 32}] |
| 177 | # or |
| 178 | # metrics: [{name: "progress", double_value: 0.56}, |
| 179 | # {name: "progress scale", double_value: 1.0}] |
| 180 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 182 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 183 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 184 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | }, |
| 186 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 188 | "selfLink": "A String", # Server-defined URL for the resource. |
| 189 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 190 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 191 | # or |
| 192 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 193 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | "zone": "A String", # The name of the Google Compute Engine |
| 195 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 196 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 197 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 198 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 200 | "name": "A String", # The server-assigned ID for the operation. |
| 201 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 202 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 203 | # (e.g., ERROR or DEGRADED). |
| 204 | "code": "A String", # Machine-friendly representation of the condition |
| 205 | "message": "A String", # Human-friendly representation of the condition |
| 206 | }, |
| 207 | ], |
| 208 | "startTime": "A String", # [Output only] The time the operation started, in |
| 209 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 210 | "detail": "A String", # Detailed operation progress, if available. |
| 211 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 212 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 213 | # (e.g., ERROR or DEGRADED). |
| 214 | "code": "A String", # Machine-friendly representation of the condition |
| 215 | "message": "A String", # Human-friendly representation of the condition |
| 216 | }, |
| 217 | ], |
| 218 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | }</pre> |
| 220 | </div> |
| 221 | |
| 222 | <div class="method"> |
| 223 | <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code> |
| 224 | <pre>Lists all operations in a project in the specified zone or all zones. |
| 225 | |
| 226 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 227 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 228 | number](https://support.google.com/cloud/answer/6158840). |
| 229 | This field has been deprecated and replaced by the parent field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 230 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 231 | [zone](https://cloud.google.com/compute/docs/zones#available) to return |
| 232 | operations for, or `-` for all zones. This field has been deprecated and |
| 233 | replaced by the parent field. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 234 | parent: string, The parent (project and location) where the operations will be listed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 235 | Specified in the format `projects/*/locations/*`. |
| 236 | Location "-" matches all zones and all regions. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 237 | x__xgafv: string, V1 error format. |
| 238 | Allowed values |
| 239 | 1 - v1 error format |
| 240 | 2 - v2 error format |
| 241 | |
| 242 | Returns: |
| 243 | An object of the form: |
| 244 | |
| 245 | { # ListOperationsResponse is the result of ListOperationsRequest. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 246 | "missingZones": [ # If any zones are listed here, the list of operations returned |
| 247 | # may be missing the operations from those zones. |
| 248 | "A String", |
| 249 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 250 | "operations": [ # A list of operations in the project in the specified zone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 251 | { # This operation resource represents operations that may have happened or are |
| 252 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 253 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 254 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 255 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 256 | "stages": [ # Substages of an operation or a stage. |
| 257 | # Object with schema name: OperationProgress |
| 258 | ], |
| 259 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 260 | # Unset for single-stage operations. |
| 261 | "status": "A String", # Status of an operation stage. |
| 262 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "metrics": [ # Progress metric bundle, for example: |
| 264 | # metrics: [{name: "nodes done", int_value: 15}, |
| 265 | # {name: "nodes total", int_value: 32}] |
| 266 | # or |
| 267 | # metrics: [{name: "progress", double_value: 0.56}, |
| 268 | # {name: "progress scale", double_value: 1.0}] |
| 269 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 270 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 271 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 272 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 273 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 274 | }, |
| 275 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 277 | "selfLink": "A String", # Server-defined URL for the resource. |
| 278 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 279 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 280 | # or |
| 281 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 282 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "zone": "A String", # The name of the Google Compute Engine |
| 284 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 285 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 286 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 287 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 288 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 289 | "name": "A String", # The server-assigned ID for the operation. |
| 290 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 291 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 292 | # (e.g., ERROR or DEGRADED). |
| 293 | "code": "A String", # Machine-friendly representation of the condition |
| 294 | "message": "A String", # Human-friendly representation of the condition |
| 295 | }, |
| 296 | ], |
| 297 | "startTime": "A String", # [Output only] The time the operation started, in |
| 298 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 299 | "detail": "A String", # Detailed operation progress, if available. |
| 300 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 301 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 302 | # (e.g., ERROR or DEGRADED). |
| 303 | "code": "A String", # Machine-friendly representation of the condition |
| 304 | "message": "A String", # Human-friendly representation of the condition |
| 305 | }, |
| 306 | ], |
| 307 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 308 | }, |
| 309 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 310 | }</pre> |
| 311 | </div> |
| 312 | |
| 313 | </body></html> |