blob: 768285df04bb2eb7c4f509b1b57fa41624347387 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="redis_v1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1.projects.html">projects</a> . <a href="redis_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="redis_v1.projects.locations.instances.html">instances()</a></code>
</p>
<p class="firstline">Returns the instances Resource.</p>
<p class="toc_element">
<code><a href="redis_v1.projects.locations.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information about a location.
Args:
name: string, Resource name for the location. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents Google Cloud Platform location.
&quot;labels&quot;: { # Cross-service attributes for the location. For example
#
# {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
&quot;a_key&quot;: &quot;A String&quot;,
},
&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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # Full resource name for the region. For example: &quot;projects/example-project/locations/us-east1&quot;.
&quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
# For example, &quot;Tokyo&quot;.
&quot;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
pageToken: string, The standard list page token.
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Locations.ListLocations.
&quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
&quot;labels&quot;: { # Cross-service attributes for the location. For example
#
# {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
&quot;a_key&quot;: &quot;A String&quot;,
},
&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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # Full resource name for the region. For example: &quot;projects/example-project/locations/us-east1&quot;.
&quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
# For example, &quot;Tokyo&quot;.
&quot;locationId&quot;: &quot;A String&quot;, # Resource ID for the region. For example: &quot;us-east1&quot;.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>