Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / redis_v1beta1.projects.locations.html
blob: f6d8f53804e00c96f5a4359aee1a7efc7dc290a9 [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">
88 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
89<p class="firstline">Gets information about a location.</p>
90<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91 <code><a href="#list">list(name, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="firstline">Lists information about the supported locations for this service.</p>
93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="get">get(name, x__xgafv=None)</code>
99 <pre>Gets information about a location.
100
101Args:
102 name: string, Resource name for the location. (required)
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;labels&quot;: { # Cross-service attributes for the location. For example
113 #
114 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
115 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]117 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
118 # For example, &quot;Tokyo&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]119 &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.
120 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
121 },
122 &quot;name&quot;: &quot;A String&quot;, # Full resource name for the region. For example: &quot;projects/example-project/locations/us-east1&quot;.
123 &quot;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 }</pre>
125</div>
126
127<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 <code class="details" id="list">list(name, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 <pre>Lists information about the supported locations for this service.
130
131Args:
132 name: string, The resource that owns the locations collection, if applicable. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 pageSize: integer, The standard list page size.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 pageToken: string, The standard list page token.
135 filter: string, The standard list filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140
141Returns:
142 An object of the form:
143
144 { # The response message for Locations.ListLocations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &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]146 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;labels&quot;: { # Cross-service attributes for the location. For example
148 #
149 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
150 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]152 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
153 # For example, &quot;Tokyo&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 &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.
155 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
156 },
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;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 },
160 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
167 <pre>Retrieves the next page of results.
168
169Args:
170 previous_request: The request for the previous page. (required)
171 previous_response: The response from the request for the previous page. (required)
172
173Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 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]175 page. Returns None if there are no more items in the collection.
176 </pre>
177</div>
178
179</body></html>