| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 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="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 Frenkel | 3e17f89 | 2020-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 Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-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 Kim | 673ec5c | 2020-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 Cheemalapati | c30d2b5 | 2017-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 Frenkel | 3e17f89 | 2020-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 Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 96 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 97 | <pre>Gets information about a particular instance configuration. |
| 98 | |
| 99 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-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 Cheemalapati | c30d2b5 | 2017-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 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| Dmitry Frenkel | 3e17f89 | 2020-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 Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 110 | "displayName": "A String", # The name of this instance configuration as it appears in UIs. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 111 | "leaderOptions": [ # Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration. |
| 112 | "A String", |
| 113 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 114 | "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*` |
| 115 | "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. |
| 116 | { |
| 117 | "defaultLeaderLocation": 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. |
| 118 | "location": "A String", # The location of the serving resources, e.g. "us-central1". |
| 119 | "type": "A String", # The type of replica. |
| 120 | }, |
| 121 | ], |
| 122 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 126 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 127 | <pre>Lists the supported instance configurations for a given project. |
| 128 | |
| 129 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 130 | 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 Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 131 | pageSize: integer, Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 132 | pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 133 | x__xgafv: string, V1 error format. |
| 134 | Allowed values |
| 135 | 1 - v1 error format |
| 136 | 2 - v2 error format |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 137 | |
| 138 | Returns: |
| 139 | An object of the form: |
| 140 | |
| 141 | { # The response for ListInstanceConfigs. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 142 | "instanceConfigs": [ # The list of requested instance configurations. |
| 143 | { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. |
| 144 | "displayName": "A String", # The name of this instance configuration as it appears in UIs. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 145 | "leaderOptions": [ # Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration. |
| 146 | "A String", |
| 147 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 148 | "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*` |
| 149 | "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. |
| 150 | { |
| 151 | "defaultLeaderLocation": 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. |
| 152 | "location": "A String", # The location of the serving resources, e.g. "us-central1". |
| 153 | "type": "A String", # The type of replica. |
| 154 | }, |
| 155 | ], |
| 156 | }, |
| 157 | ], |
| 158 | "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. |
| 159 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 160 | </div> |
| 161 | |
| 162 | <div class="method"> |
| 163 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 164 | <pre>Retrieves the next page of results. |
| 165 | |
| 166 | Args: |
| 167 | previous_request: The request for the previous page. (required) |
| 168 | previous_response: The response from the request for the previous page. (required) |
| 169 | |
| 170 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 172 | page. Returns None if there are no more items in the collection. |
| 173 | </pre> |
| 174 | </div> |
| 175 | |
| 176 | </body></html> |