• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
91  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
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.
112    "displayName": "A String", # The friendly name for this location, typically a nearby city name.
113        # For example, "Tokyo".
114    "labels": { # Cross-service attributes for the location. For example
115        #
116        #     {"cloud.googleapis.com/region": "us-east1"}
117      "a_key": "A String",
118    },
119    "locationId": "A String", # Resource ID for the region. For example: "us-east1".
120    "name": "A String", # Full resource name for the region. For example: "projects/example-project/locations/us-east1".
121    "metadata": { # 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.
122      "a_key": "", # Properties of the object. Contains field @type with type URL.
123    },
124  }</pre>
125</div>
126
127<div class="method">
128    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
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)
133  pageToken: string, The standard list page token.
134  x__xgafv: string, V1 error format.
135    Allowed values
136      1 - v1 error format
137      2 - v2 error format
138  pageSize: integer, The standard list page size.
139  filter: string, The standard list filter.
140
141Returns:
142  An object of the form:
143
144    { # The response message for Locations.ListLocations.
145    "nextPageToken": "A String", # The standard List next-page token.
146    "locations": [ # A list of locations that matches the specified filter in the request.
147      { # A resource that represents Google Cloud Platform location.
148        "displayName": "A String", # The friendly name for this location, typically a nearby city name.
149            # For example, "Tokyo".
150        "labels": { # Cross-service attributes for the location. For example
151            #
152            #     {"cloud.googleapis.com/region": "us-east1"}
153          "a_key": "A String",
154        },
155        "locationId": "A String", # Resource ID for the region. For example: "us-east1".
156        "name": "A String", # Full resource name for the region. For example: "projects/example-project/locations/us-east1".
157        "metadata": { # 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.
158          "a_key": "", # Properties of the object. Contains field @type with type URL.
159        },
160      },
161    ],
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:
174  A request object that you can call 'execute()' on to request the next
175  page. Returns None if there are no more items in the collection.
176    </pre>
177</div>
178
179</body></html>