blob: 67871bb22ed6679c2e47fb1b8f37f4738cb1e6a8 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<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">Google Container 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="#get">get(projectId, zoneId, operationId)</a></code></p>
79<p class="firstline">Gets the specified operation.</p>
80<p class="toc_element">
81 <code><a href="#list">list(projectId, zoneId)</a></code></p>
82<p class="firstline">Lists all operations in a project in a specific zone.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(projectId, zoneId, operationId)</code>
86 <pre>Gets the specified operation.
87
88Args:
89 projectId: string, The Google Developers Console project ID or project number. (required)
90 zoneId: string, The name of the Google Compute Engine zone in which the operation resides. This is always the same zone as the cluster with which the operation is associated. (required)
91 operationId: string, The server-assigned name of the operation. (required)
92
93Returns:
94 An object of the form:
95
96 { # Defines the operation resource. All fields are output only.
97 "status": "A String", # The current status of the operation.
98 "name": "A String", # The server-assigned ID for this operation. If the operation is fulfilled upfront, it may not have a resource name.
99 "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
100 "errorMessage": "A String", # If an error has occurred, a textual description of the error.
101 "targetLink": "A String", # Server-defined URL for the target of the operation.
102 "operationType": "A String", # The operation type.
103 "selfLink": "A String", # Server-defined URL for the resource.
104 "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
105 }</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="list">list(projectId, zoneId)</code>
110 <pre>Lists all operations in a project in a specific zone.
111
112Args:
113 projectId: string, The Google Developers Console project ID or project number. (required)
114 zoneId: string, The name of the Google Compute Engine zone to return operations for. (required)
115
116Returns:
117 An object of the form:
118
119 {
120 "operations": [ # A list of operations in the project in the specified zone.
121 { # Defines the operation resource. All fields are output only.
122 "status": "A String", # The current status of the operation.
123 "name": "A String", # The server-assigned ID for this operation. If the operation is fulfilled upfront, it may not have a resource name.
124 "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
125 "errorMessage": "A String", # If an error has occurred, a textual description of the error.
126 "targetLink": "A String", # Server-defined URL for the target of the operation.
127 "operationType": "A String", # The operation type.
128 "selfLink": "A String", # Server-defined URL for the resource.
129 "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
130 },
131 ],
132 }</pre>
133</div>
134
135</body></html>