Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7578da5dc1ea87d1992fda18898270eb8253a2c6 / . / docs / dyn / compute_v1beta12.zones.html
blob: 0e13d05306ffa6ccd0cbbbfa257f7e60b5ee9b6a [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[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="compute_v1beta12.html">Compute Engine API</a> . <a href="compute_v1beta12.zones.html">zones</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, zone)</a></code></p>
79<p class="firstline">Returns the specified zone resource.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of zone resources available to the specified project.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(project, zone)</code>
89 <pre>Returns the specified zone resource.
90
91Args:
92 project: string, Name of the project scoping this request. (required)
93 zone: string, Name of the zone resource to return. (required)
94
95Returns:
96 An object of the form:
97
98 {
99 "status": "A String", # Status of the zone. "UP" or "DOWN".
100 "kind": "compute#zone", # Type of the resource.
101 "availableMachineType": [ # The machine types that can be used in this zone (output only).
102 "",
103 ],
104 "description": "A String", # Textual description of the resource.
105 "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
106 {
107 "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
108 "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
109 "name": "A String", # Name of the maintenance window.
110 "description": "A String", # Textual description of the maintenance window.
111 },
112 ],
113 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
114 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
115 "selfLink": "A String", # Server defined URL for the resource (output only).
116 "name": "A String", # Name of the resource.
117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
122 <pre>Retrieves the list of zone resources available to the specified project.
123
124Args:
125 project: string, Name of the project scoping this request. (required)
126 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
127 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
128 filter: string, Optional. Filter expression for filtering listed resources.
129
130Returns:
131 An object of the form:
132
133 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]134 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]135 "items": [ # The zone resources.
136 {
137 "status": "A String", # Status of the zone. "UP" or "DOWN".
138 "kind": "compute#zone", # Type of the resource.
139 "availableMachineType": [ # The machine types that can be used in this zone (output only).
140 "",
141 ],
142 "description": "A String", # Textual description of the resource.
143 "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
144 {
145 "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
146 "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
147 "name": "A String", # Name of the maintenance window.
148 "description": "A String", # Textual description of the maintenance window.
149 },
150 ],
151 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
152 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
153 "selfLink": "A String", # Server defined URL for the resource (output only).
154 "name": "A String", # Name of the resource.
155 },
156 ],
157 "kind": "compute#zoneList", # Type of resource.
158 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
159 "selfLink": "A String", # Server defined URL for this resource (output only).
160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
165 <pre>Retrieves the next page of results.
166
167Args:
168 previous_request: The request for the previous page. (required)
169 previous_response: The response from the request for the previous page. (required)
170
171Returns:
172 A request object that you can call 'execute()' on to request the next
173 page. Returns None if there are no more items in the collection.
174 </pre>
175</div>
176
177</body></html>