Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / container_v1.projects.zones.operations.html
blob: 19e9aca8fb1faff8f3798c1a98d43ec9a5bc4330 [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:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]92 projectId: string, The Google Developers Console [project ID or project
93number](https://support.google.com/cloud/answer/6158840). (required)
94 zone: string, The name of the Google Compute Engine
95[zone](/compute/docs/zones#available) in which the operation resides. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 operationId: string, The server-assigned `name` of the operation. (required)
97 body: object, The request body. (required)
98 The object takes the form of:
99
100{ # CancelOperationRequest cancels a single operation.
101 }
102
103 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]107
108Returns:
109 An object of the form:
110
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]111 { # A generic empty message that you can re-use to avoid defining duplicated
112 # empty messages in your APIs. A typical example is to use it as the request
113 # or the response type of an API method. For instance:
114 #
115 # service Foo {
116 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
117 # }
118 #
119 # The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 }</pre>
121</div>
122
123<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]124 <code class="details" id="get">get(projectId, zone, operationId, x__xgafv=None)</code>
125 <pre>Gets the specified operation.
126
127Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]128 projectId: string, The Google Developers Console [project ID or project
129number](https://support.google.com/cloud/answer/6158840). (required)
130 zone: string, The name of the Google Compute Engine
131[zone](/compute/docs/zones#available) in which the cluster
132resides. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133 operationId: string, The server-assigned `name` of the operation. (required)
134 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138
139Returns:
140 An object of the form:
141
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]142 { # This operation resource represents operations that may have happened or are
143 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]144 "status": "A String", # The current status of the operation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]146 "name": "A String", # The server-assigned ID for the operation.
147 "zone": "A String", # The name of the Google Compute Engine
148 # [zone](/compute/docs/zones#available) in which the operation
149 # is taking place.
150 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]151 "targetLink": "A String", # Server-defined URL for the target of the operation.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]152 "operationType": "A String", # The operation type.
153 "selfLink": "A String", # Server-defined URL for the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="list">list(projectId, zone, x__xgafv=None)</code>
159 <pre>Lists all operations in a project in a specific zone or all zones.
160
161Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]162 projectId: string, The Google Developers Console [project ID or project
163number](https://support.google.com/cloud/answer/6158840). (required)
164 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available)
165to return operations for, or `-` for all zones. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]170
171Returns:
172 An object of the form:
173
174 { # ListOperationsResponse is the result of ListOperationsRequest.
175 "operations": [ # A list of operations in the project in the specified zone.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]176 { # This operation resource represents operations that may have happened or are
177 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 "status": "A String", # The current status of the operation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]179 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]180 "name": "A String", # The server-assigned ID for the operation.
181 "zone": "A String", # The name of the Google Compute Engine
182 # [zone](/compute/docs/zones#available) in which the operation
183 # is taking place.
184 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]185 "targetLink": "A String", # Server-defined URL for the target of the operation.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]186 "operationType": "A String", # The operation type.
187 "selfLink": "A String", # Server-defined URL for the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188 },
189 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]190 "missingZones": [ # If any zones are listed here, the list of operations returned
191 # may be missing the operations from those zones.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]192 "A String",
193 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]194 }</pre>
195</div>
196
197</body></html>