Debian Codegraph @

docs/dyn/bigtableadmin_v2.projects.instances.clusters.memoryLayers.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a> . <a href="bigtableadmin_v2.projects.instances.clusters.memoryLayers.html">memoryLayers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lists information about memory layers.</p>
83 <p class="toc_element">
84 <code><a href="#list_next">list_next()</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="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
94 <pre>Lists information about memory layers.
95
96 Args:
97 parent: string, Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = &#x27;-&#x27;` to list MemoryLayers for all Clusters in an instance, e.g., `projects/myproject/instances/myinstance/clusters/-`. (required)
98 pageSize: integer, Optional. The maximum number of memory layers to return. The service may return fewer than this value.
99 pageToken: string, Optional. A page token, received from a previous `ListMemoryLayers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMemoryLayers` must match the call that provided the page token.
100 x__xgafv: string, V1 error format.
101 Allowed values
102 1 - v1 error format
103 2 - v2 error format
104
105 Returns:
106 An object of the form:
107
108 { # Response message for BigtableInstanceAdmin.ListMemoryLayers.
109 &quot;failedLocations&quot;: [ # Locations from which MemoryLayer information could not be retrieved, due to an outage or some other transient condition. MemoryLayers from these locations may be missing from `memory_layers`, or may only have partial information returned. Values are of the form `projects//locations/`
110 &quot;A String&quot;,
111 ],
112 &quot;memoryLayers&quot;: [ # The list of requested memory layers.
113 { # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
114 &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
115 &quot;memoryConfig&quot;: { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
116 &quot;storageSizeGib&quot;: 42, # Output only. Reporting the current size of the memory layer in GiB.
117 },
118 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the memory layer. This is always: &quot;projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer&quot;.
119 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the memory layer.
120 },
121 ],
122 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
123 }</pre>
124 </div>
125
126 <div class="method">
127 <code class="details" id="list_next">list_next()</code>
128 <pre>Retrieves the next page of results.
129
130 Args:
131 previous_request: The request for the previous page. (required)
132 previous_response: The response from the request for the previous page. (required)
133
134 Returns:
135 A request object that you can call &#x27;execute()&#x27; on to request the next
136 page. Returns None if there are no more items in the collection.
137 </pre>
138 </div>
139
140 </body></html>