• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
78  <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
81  <code><a href="#get">get(name, projectId=None, zone=None, x__xgafv=None, operationId=None)</a></code></p>
82<p class="firstline">Gets the specified operation.</p>
83<p class="toc_element">
84  <code><a href="#list">list(parent, projectId=None, zone=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists all operations in a project in a specific zone or all zones.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="cancel">cancel(name, body, x__xgafv=None)</code>
89  <pre>Cancels the specified operation.
90
91Args:
92  name: string, The name (project, location, operation id) of the operation to cancel.
93Specified in the format 'projects/*/locations/*/operations/*'. (required)
94  body: object, The request body. (required)
95    The object takes the form of:
96
97{ # CancelOperationRequest cancels a single operation.
98    "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
99        # number](https://support.google.com/cloud/answer/6158840).
100        # This field has been deprecated and replaced by the name field.
101    "name": "A String", # The name (project, location, operation id) of the operation to cancel.
102        # Specified in the format 'projects/*/locations/*/operations/*'.
103    "zone": "A String", # Deprecated. The name of the Google Compute Engine
104        # [zone](/compute/docs/zones#available) in which the operation resides.
105        # This field has been deprecated and replaced by the name field.
106    "operationId": "A String", # Deprecated. The server-assigned `name` of the operation.
107        # This field has been deprecated and replaced by the name field.
108  }
109
110  x__xgafv: string, V1 error format.
111    Allowed values
112      1 - v1 error format
113      2 - v2 error format
114
115Returns:
116  An object of the form:
117
118    { # A generic empty message that you can re-use to avoid defining duplicated
119      # empty messages in your APIs. A typical example is to use it as the request
120      # or the response type of an API method. For instance:
121      #
122      #     service Foo {
123      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
124      #     }
125      #
126      # The JSON representation for `Empty` is empty JSON object `{}`.
127  }</pre>
128</div>
129
130<div class="method">
131    <code class="details" id="get">get(name, projectId=None, zone=None, x__xgafv=None, operationId=None)</code>
132  <pre>Gets the specified operation.
133
134Args:
135  name: string, The name (project, location, operation id) of the operation to get.
136Specified in the format 'projects/*/locations/*/operations/*'. (required)
137  projectId: string, Deprecated. The Google Developers Console [project ID or project
138number](https://support.google.com/cloud/answer/6158840).
139This field has been deprecated and replaced by the name field.
140  zone: string, Deprecated. The name of the Google Compute Engine
141[zone](/compute/docs/zones#available) in which the cluster
142resides.
143This field has been deprecated and replaced by the name field.
144  x__xgafv: string, V1 error format.
145    Allowed values
146      1 - v1 error format
147      2 - v2 error format
148  operationId: string, Deprecated. The server-assigned `name` of the operation.
149This field has been deprecated and replaced by the name field.
150
151Returns:
152  An object of the form:
153
154    { # This operation resource represents operations that may have happened or are
155      # happening on the cluster. All fields are output only.
156    "status": "A String", # The current status of the operation.
157    "selfLink": "A String", # Server-defined URL for the resource.
158    "name": "A String", # The server-assigned ID for the operation.
159    "zone": "A String", # The name of the Google Compute Engine
160        # [zone](/compute/docs/zones#available) in which the operation
161        # is taking place.
162        # This field is deprecated, use location instead.
163    "startTime": "A String", # [Output only] The time the operation started, in
164        # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
165    "detail": "A String", # Detailed operation progress, if available.
166    "operationType": "A String", # The operation type.
167    "targetLink": "A String", # Server-defined URL for the target of the operation.
168    "location": "A String", # [Output only] The name of the Google Compute Engine
169        # [zone](/compute/docs/regions-zones/regions-zones#available) or
170        # [region](/compute/docs/regions-zones/regions-zones#available) in which
171        # the cluster resides.
172    "nodepoolConditions": [ # Which conditions caused the current node pool state.
173      { # StatusCondition describes why a cluster or a node pool has a certain status
174          # (e.g., ERROR or DEGRADED).
175        "message": "A String", # Human-friendly representation of the condition
176        "code": "A String", # Machine-friendly representation of the condition
177      },
178    ],
179    "endTime": "A String", # [Output only] The time the operation completed, in
180        # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
181    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
182    "clusterConditions": [ # Which conditions caused the current cluster state.
183      { # StatusCondition describes why a cluster or a node pool has a certain status
184          # (e.g., ERROR or DEGRADED).
185        "message": "A String", # Human-friendly representation of the condition
186        "code": "A String", # Machine-friendly representation of the condition
187      },
188    ],
189  }</pre>
190</div>
191
192<div class="method">
193    <code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=None)</code>
194  <pre>Lists all operations in a project in a specific zone or all zones.
195
196Args:
197  parent: string, The parent (project and location) where the operations will be listed.
198Specified in the format 'projects/*/locations/*'.
199Location "-" matches all zones and all regions. (required)
200  projectId: string, Deprecated. The Google Developers Console [project ID or project
201number](https://support.google.com/cloud/answer/6158840).
202This field has been deprecated and replaced by the parent field.
203  zone: string, Deprecated. The name of the Google Compute Engine
204[zone](/compute/docs/zones#available) to return operations for, or `-` for
205all zones. This field has been deprecated and replaced by the parent field.
206  x__xgafv: string, V1 error format.
207    Allowed values
208      1 - v1 error format
209      2 - v2 error format
210
211Returns:
212  An object of the form:
213
214    { # ListOperationsResponse is the result of ListOperationsRequest.
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
217          # happening on the cluster. All fields are output only.
218        "status": "A String", # The current status of the operation.
219        "selfLink": "A String", # Server-defined URL for the resource.
220        "name": "A String", # The server-assigned ID for the operation.
221        "zone": "A String", # The name of the Google Compute Engine
222            # [zone](/compute/docs/zones#available) in which the operation
223            # is taking place.
224            # This field is deprecated, use location instead.
225        "startTime": "A String", # [Output only] The time the operation started, in
226            # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
227        "detail": "A String", # Detailed operation progress, if available.
228        "operationType": "A String", # The operation type.
229        "targetLink": "A String", # Server-defined URL for the target of the operation.
230        "location": "A String", # [Output only] The name of the Google Compute Engine
231            # [zone](/compute/docs/regions-zones/regions-zones#available) or
232            # [region](/compute/docs/regions-zones/regions-zones#available) in which
233            # the cluster resides.
234        "nodepoolConditions": [ # Which conditions caused the current node pool state.
235          { # StatusCondition describes why a cluster or a node pool has a certain status
236              # (e.g., ERROR or DEGRADED).
237            "message": "A String", # Human-friendly representation of the condition
238            "code": "A String", # Machine-friendly representation of the condition
239          },
240        ],
241        "endTime": "A String", # [Output only] The time the operation completed, in
242            # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
243        "statusMessage": "A String", # If an error has occurred, a textual description of the error.
244        "clusterConditions": [ # Which conditions caused the current cluster state.
245          { # StatusCondition describes why a cluster or a node pool has a certain status
246              # (e.g., ERROR or DEGRADED).
247            "message": "A String", # Human-friendly representation of the condition
248            "code": "A String", # Machine-friendly representation of the condition
249          },
250        ],
251      },
252    ],
253    "missingZones": [ # If any zones are listed here, the list of operations returned
254        # may be missing the operations from those zones.
255      "A String",
256    ],
257  }</pre>
258</div>
259
260</body></html>