Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / compute_v1.zones.html
blob: 5981a1a4d0ba0d947c2121f6247e54dddd42801a [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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Returns the specified Zone resource. Get a list of available zones by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]81 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Retrieves the list of Zone resources available to the specified project.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89 <pre>Returns the specified Zone resource. Get a list of available zones by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100 "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101 "description": "A String", # [Output Only] Textual description of the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]102 "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]103 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
104 "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]105 "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]106 "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]107 "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]108 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109 "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
110 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 }</pre>
115</div>
116
117<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]118 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]119 <pre>Retrieves the list of Zone resources available to the specified project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120
121Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]123 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
124
125You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
126
127Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
129 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
130 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]132The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]134For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]138To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139
140Returns:
141 An object of the form:
142
143 { # Contains a list of zone resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]145 "items": [ # [Output Only] A list of Zone resources.
146 { # A Zone resource.
147 "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]149 "description": "A String", # [Output Only] Textual description of the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]150 "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]151 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
152 "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]153 "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]154 "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]155 "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]156 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]157 "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
158 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]160 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 },
163 ],
164 "kind": "compute#zoneList", # Type of resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]165 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
172 <pre>Retrieves the next page of results.
173
174Args:
175 previous_request: The request for the previous page. (required)
176 previous_response: The response from the request for the previous page. (required)
177
178Returns:
179 A request object that you can call 'execute()' on to request the next
180 page. Returns None if there are no more items in the collection.
181 </pre>
182</div>
183
184</body></html>