| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [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="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.availableLocations.html">availableLocations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 79 | <p class="firstline">Returns a list of valid Google Cloud Platform (GCP) resource locations for</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 85 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 86 | <pre>Returns a list of valid Google Cloud Platform (GCP) resource locations for |
| 87 | the specified Project (including a FirebaseProject). |
| 88 | <br> |
| 89 | <br>One of these locations can be selected as the Project's [_default_ GCP |
| 90 | resource location](https://firebase.google.com/docs/projects/locations), |
| 91 | which is the geographical location where project resources, such as Cloud |
| 92 | Firestore, will be provisioned by default. However, if the default GCP |
| 93 | resource location has already been set for the Project, then this setting |
| 94 | cannot be changed. |
| 95 | <br> |
| 96 | <br>This call checks for any possible |
| 97 | [location |
| 98 | restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) |
| 99 | for the specified Project and, thus, might return a subset of all possible |
| 100 | GCP resource locations. To list all GCP resource locations (regardless of |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 101 | any restrictions), call the endpoint without specifying a `PROJECT_NUMBER` |
| 102 | (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). <br> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | <br>To call `ListAvailableLocations` with a specified project, a member |
| 104 | must be at minimum a Viewer of the project. Calls without a specified |
| 105 | project do not require any specific project permissions. |
| 106 | |
| 107 | Args: |
| 108 | parent: string, The Project for which to list GCP resource locations, in the format: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 109 | <br><code>projects/<var>PROJECT_NUMBER</var></code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | <br>If no project is specified (that is, `projects/-`), the returned list |
| 111 | does not take into account org-specific or project-specific location |
| 112 | restrictions. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 113 | pageToken: string, Token returned from a previous call to `ListAvailableLocations` indicating |
| 114 | where in the list of locations to resume listing. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | pageSize: integer, The maximum number of locations to return in the response. |
| 116 | <br> |
| 117 | <br>The server may return fewer than this value at its discretion. |
| 118 | If no value is specified (or too large a value is specified), then the |
| 119 | server will impose its own limit. |
| 120 | <br> |
| 121 | <br>This value cannot be negative. |
| 122 | x__xgafv: string, V1 error format. |
| 123 | Allowed values |
| 124 | 1 - v1 error format |
| 125 | 2 - v2 error format |
| 126 | |
| 127 | Returns: |
| 128 | An object of the form: |
| 129 | |
| 130 | { |
| 131 | "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token |
| 132 | # is returned. If the string is empty, then this response is the last page of |
| 133 | # results and all available locations have been listed. |
| 134 | # <br> |
| 135 | # <br>This token can be used in a subsequent call to |
| 136 | # `ListAvailableLocations` to find more locations. |
| 137 | # <br> |
| 138 | # <br>Page tokens are short-lived and should not be persisted. |
| 139 | "locations": [ # One page of results from a call to `ListAvailableLocations`. |
| 140 | { # A GCP resource location that can be selected for a Project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "type": "A String", # Indicates whether the GCP resource location is a [regional or |
| 142 | # multi-regional |
| 143 | # location](https://firebase.google.com/docs/projects/locations#types) |
| 144 | # for data replication. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 145 | "locationId": "A String", # The ID of the GCP resource location. It will be one of the available [GCP |
| 146 | # resource |
| 147 | # locations](https://firebase.google.com/docs/projects/locations#types). |
| 148 | "features": [ # Products and services that are available in the GCP resource location. |
| 149 | "A String", |
| 150 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | }, |
| 152 | ], |
| 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 | |
| 160 | Args: |
| 161 | previous_request: The request for the previous page. (required) |
| 162 | previous_response: The response from the request for the previous page. (required) |
| 163 | |
| 164 | Returns: |
| 165 | A request object that you can call 'execute()' on to request the next |
| 166 | page. Returns None if there are no more items in the collection. |
| 167 | </pre> |
| 168 | </div> |
| 169 | |
| 170 | </body></html> |