Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 42818cfca63bf2d3d257ff8859939dcf6839456e / . / docs / dyn / container_v1.projects.zones.operations.html
blob: 0ef563a28bb13864a532b66919dd32543ba8052c [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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">Google Container Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="#cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]81 <code><a href="#get">get(projectId, zone, operationId, 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, 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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88 <code class="details" id="cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</code>
89 <pre>Cancels the specified operation.
90
91Args:
92 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
93 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. (required)
94 operationId: string, The server-assigned `name` of the operation. (required)
95 body: object, The request body. (required)
96 The object takes the form of:
97
98{ # CancelOperationRequest cancels a single operation.
99 }
100
101 x__xgafv: string, V1 error format.
102
103Returns:
104 An object of the form:
105
106 { # 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 `{}`.
107 }</pre>
108</div>
109
110<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]111 <code class="details" id="get">get(projectId, zone, operationId, x__xgafv=None)</code>
112 <pre>Gets the specified operation.
113
114Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]116 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
117 operationId: string, The server-assigned `name` of the operation. (required)
118 x__xgafv: string, V1 error format.
119
120Returns:
121 An object of the form:
122
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]123 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]124 "status": "A String", # The current status of the operation.
125 "name": "A String", # The server-assigned ID for the operation.
126 "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]127 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]128 "selfLink": "A String", # Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]129 "operationType": "A String", # The operation type.
130 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 "targetLink": "A String", # Server-defined URL for the target of the operation.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="list">list(projectId, zone, x__xgafv=None)</code>
137 <pre>Lists all operations in a project in a specific zone or all zones.
138
139Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]140 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
141 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]142 x__xgafv: string, V1 error format.
143
144Returns:
145 An object of the form:
146
147 { # ListOperationsResponse is the result of ListOperationsRequest.
148 "operations": [ # A list of operations in the project in the specified zone.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]149 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]150 "status": "A String", # The current status of the operation.
151 "name": "A String", # The server-assigned ID for the operation.
152 "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]153 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154 "selfLink": "A String", # Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]155 "operationType": "A String", # The operation type.
156 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]157 "targetLink": "A String", # Server-defined URL for the target of the operation.
158 },
159 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]160 "missingZones": [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
161 "A String",
162 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]163 }</pre>
164</div>
165
166</body></html>