Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / spanner_v1.projects.instanceConfigs.html
blob: e89862645e1c401c6a519b7be4cfdbf9f7b1dee0 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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="spanner_v1.html">Cloud Spanner API</a> . <a href="spanner_v1.projects.html">projects</a> . <a href="spanner_v1.projects.instanceConfigs.html">instanceConfigs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Gets information about a particular instance configuration.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Lists the supported instance configurations for a given project.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]96 <code class="details" id="get">get(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97 <pre>Gets information about a particular instance configuration.
98
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 name: string, Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]110 &quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111 &quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]113 &quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g. &quot;us-central1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 &quot;type&quot;: &quot;A String&quot;, # The type of replica.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]115 &quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 },
117 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]118 &quot;displayName&quot;: &quot;A String&quot;, # The name of this instance configuration as it appears in UIs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]119 }</pre>
120</div>
121
122<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]123 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]124 <pre>Lists the supported instance configurations for a given project.
125
126Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127 parent: string, Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 pageSize: integer, Number of instance configurations to be returned in the response. If 0 or less, defaults to the server&#x27;s maximum allowed page size.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]129 pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]134
135Returns:
136 An object of the form:
137
138 { # The response for ListInstanceConfigs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;instanceConfigs&quot;: [ # The list of requested instance configurations.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]141 &quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 &quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]144 &quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g. &quot;us-central1&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 &quot;type&quot;: &quot;A String&quot;, # The type of replica.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]146 &quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 },
148 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]149 &quot;displayName&quot;: &quot;A String&quot;, # The name of this instance configuration as it appears in UIs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]150 },
151 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;nextPageToken&quot;: &quot;A String&quot;, # `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
158 <pre>Retrieves the next page of results.
159
160Args:
161 previous_request: The request for the previous page. (required)
162 previous_response: The response from the request for the previous page. (required)
163
164Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]166 page. Returns None if there are no more items in the collection.
167 </pre>
168</div>
169
170</body></html>