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