Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / redis_v1beta1.projects.locations.html
blob: 26c3f215ba85fae595e4d710d5220526303d3aa8 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="redis_v1beta1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1beta1.projects.html">projects</a> . <a href="redis_v1beta1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="redis_v1beta1.projects.locations.instances.html">instances()</a></code>
79</p>
80<p class="firstline">Returns the instances Resource.</p>
81
82<p class="toc_element">
83 <code><a href="redis_v1beta1.projects.locations.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
92<p class="firstline">Gets information about a location.</p>
93<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="firstline">Lists information about the supported locations for this service.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<h3>Method Details</h3>
100<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]101 <code class="details" id="close">close()</code>
102 <pre>Close httplib2 connections.</pre>
103</div>
104
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <code class="details" id="get">get(name, x__xgafv=None)</code>
107 <pre>Gets information about a location.
108
109Args:
110 name: string, Resource name for the location. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]120 &quot;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
122 &quot;a_key&quot;: &quot;A String&quot;,
123 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]124 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
125 &quot;name&quot;: &quot;A String&quot;, # Full resource name for the region. For example: &quot;projects/example-project/locations/us-east1&quot;.
126 &quot;metadata&quot;: { # Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
127 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
128 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 }</pre>
130</div>
131
132<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]133 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 <pre>Lists information about the supported locations for this service.
135
136Args:
137 name: string, The resource that owns the locations collection, if applicable. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 pageSize: integer, The standard list page size.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 filter: string, The standard list filter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 pageToken: string, The standard list page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145
146Returns:
147 An object of the form:
148
149 { # The response message for Locations.ListLocations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
154 &quot;a_key&quot;: &quot;A String&quot;,
155 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]156 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
157 &quot;name&quot;: &quot;A String&quot;, # Full resource name for the region. For example: &quot;projects/example-project/locations/us-east1&quot;.
158 &quot;metadata&quot;: { # Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
159 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
160 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 },
162 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
169 <pre>Retrieves the next page of results.
170
171Args:
172 previous_request: The request for the previous page. (required)
173 previous_response: The response from the request for the previous page. (required)
174
175Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 page. Returns None if there are no more items in the collection.
178 </pre>
179</div>
180
181</body></html>