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