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_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"> 78 <code><a href="#cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Cancels the specified operation.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(projectId, zone, operationId, name=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the specified operation.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p> 88<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"> 91 <code class="details" id="cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</code> 92 <pre>Cancels the specified operation. 93 94Args: 95 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. (required) 96 zone: string, 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. (required) 97 operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required) 98 body: object, The request body. 99 The object takes the form of: 100 101{ # CancelOperationRequest cancels a single operation. 102 "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. 103 "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. 104 "projectId": "A 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. 105 "zone": "A String", # 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. 106} 107 108 x__xgafv: string, V1 error format. 109 Allowed values 110 1 - v1 error format 111 2 - v2 error format 112 113Returns: 114 An object of the form: 115 116 { # 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 `{}`. 117}</pre> 118</div> 119 120<div class="method"> 121 <code class="details" id="close">close()</code> 122 <pre>Close httplib2 connections.</pre> 123</div> 124 125<div class="method"> 126 <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code> 127 <pre>Gets the specified operation. 128 129Args: 130 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. (required) 131 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. (required) 132 operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required) 133 name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. 143 "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead. 144 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). 145 "canonicalCode": "A String", # Canonical code of the condition. 146 "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead. 147 "message": "A String", # Human-friendly representation of the condition 148 }, 149 ], 150 "detail": "A String", # Detailed operation progress, if available. 151 "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 152 "error": { # 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. 153 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 154 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 155 { 156 "a_key": "", # Properties of the object. Contains field @type with type URL. 157 }, 158 ], 159 "message": "A String", # 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. 160 }, 161 "location": "A String", # [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. 162 "name": "A String", # The server-assigned ID for the operation. 163 "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. 164 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). 165 "canonicalCode": "A String", # Canonical code of the condition. 166 "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead. 167 "message": "A String", # Human-friendly representation of the condition 168 }, 169 ], 170 "operationType": "A String", # The operation type. 171 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. 172 "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] 173 { # Progress metric is (string, int|float|string) pair. 174 "doubleValue": 3.14, # For metrics with floating point value. 175 "intValue": "A String", # For metrics with integer value. 176 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". 177 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). 178 }, 179 ], 180 "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations. 181 "stages": [ # Substages of an operation or a stage. 182 # Object with schema name: OperationProgress 183 ], 184 "status": "A String", # Status of an operation stage. Unset for single-stage operations. 185 }, 186 "selfLink": "A String", # Server-defined URL for the resource. 187 "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 188 "status": "A String", # The current status of the operation. 189 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. 190 "targetLink": "A String", # Server-defined URL for the target of the operation. 191 "zone": "A String", # 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. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code> 197 <pre>Lists all operations in a project in the specified zone or all zones. 198 199Args: 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. (required) 201 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. (required) 202 parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. 203 x__xgafv: string, V1 error format. 204 Allowed values 205 1 - v1 error format 206 2 - v2 error format 207 208Returns: 209 An object of the form: 210 211 { # ListOperationsResponse is the result of ListOperationsRequest. 212 "missingZones": [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones. 213 "A String", 214 ], 215 "operations": [ # A list of operations in the project in the specified zone. 216 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. 217 "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead. 218 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). 219 "canonicalCode": "A String", # Canonical code of the condition. 220 "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead. 221 "message": "A String", # Human-friendly representation of the condition 222 }, 223 ], 224 "detail": "A String", # Detailed operation progress, if available. 225 "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 226 "error": { # 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. 227 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 228 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 229 { 230 "a_key": "", # Properties of the object. Contains field @type with type URL. 231 }, 232 ], 233 "message": "A String", # 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. 234 }, 235 "location": "A String", # [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. 236 "name": "A String", # The server-assigned ID for the operation. 237 "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. 238 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). 239 "canonicalCode": "A String", # Canonical code of the condition. 240 "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead. 241 "message": "A String", # Human-friendly representation of the condition 242 }, 243 ], 244 "operationType": "A String", # The operation type. 245 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. 246 "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] 247 { # Progress metric is (string, int|float|string) pair. 248 "doubleValue": 3.14, # For metrics with floating point value. 249 "intValue": "A String", # For metrics with integer value. 250 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". 251 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). 252 }, 253 ], 254 "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations. 255 "stages": [ # Substages of an operation or a stage. 256 # Object with schema name: OperationProgress 257 ], 258 "status": "A String", # Status of an operation stage. Unset for single-stage operations. 259 }, 260 "selfLink": "A String", # Server-defined URL for the resource. 261 "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 262 "status": "A String", # The current status of the operation. 263 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. 264 "targetLink": "A String", # Server-defined URL for the target of the operation. 265 "zone": "A String", # 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. 266 }, 267 ], 268}</pre> 269</div> 270 271</body></html>