Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / compute_v1.zones.html
blob: 5a3a6b37ffe7d9cb2db47aeda16c143cb8df6f8b [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]92 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93 zone: string, Name of the zone resource to return. (required)
94
95Returns:
96 An object of the form:
97
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]98 { # A Zone resource.
99 "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
100 "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones.
101 "description": "A String", # [Output Only] Textual description of the resource.
102 "maintenanceWindows": [ # [Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]104 "endTime": "A String", # [Output Only] Ending time of the maintenance window, in RFC3339 format.
105 "beginTime": "A String", # [Output Only] Starting time of the maintenance window, in RFC3339 format.
106 "name": "A String", # [Output Only] Name of the maintenance window.
107 "description": "A String", # [Output Only] Textual description of the maintenance window.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 },
109 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]110 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
112 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]113 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]115 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]117 "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
118 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
119 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
120 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
121 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
127 <pre>Retrieves the list of zone resources available to the specified project.
128
129Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]130 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
132 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
133 filter: string, Optional. Filter expression for filtering listed resources.
134
135Returns:
136 An object of the form:
137
138 { # Contains a list of zone resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]139 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
140 "items": [ # [Output Only] A list of Zone resources.
141 { # A Zone resource.
142 "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
143 "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones.
144 "description": "A String", # [Output Only] Textual description of the resource.
145 "maintenanceWindows": [ # [Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]147 "endTime": "A String", # [Output Only] Ending time of the maintenance window, in RFC3339 format.
148 "beginTime": "A String", # [Output Only] Starting time of the maintenance window, in RFC3339 format.
149 "name": "A String", # [Output Only] Name of the maintenance window.
150 "description": "A String", # [Output Only] Textual description of the maintenance window.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 },
152 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]153 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
155 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]156 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]157 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]158 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]160 "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
161 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
162 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
163 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
164 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]165 },
166 ],
167 "kind": "compute#zoneList", # Type of resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]168 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 "selfLink": "A String", # Server defined URL for this resource (output only).
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
175 <pre>Retrieves the next page of results.
176
177Args:
178 previous_request: The request for the previous page. (required)
179 previous_response: The response from the request for the previous page. (required)
180
181Returns:
182 A request object that you can call 'execute()' on to request the next
183 page. Returns None if there are no more items in the collection.
184 </pre>
185</div>
186
187</body></html>