| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -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="apigateway_v1beta.html">API Gateway API</a> . <a href="apigateway_v1beta.projects.html">projects</a> . <a href="apigateway_v1beta.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="apigateway_v1beta.projects.locations.apis.html">apis()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the apis Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="apigateway_v1beta.projects.locations.gateways.html">gateways()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the gateways Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="apigateway_v1beta.projects.locations.operations.html">operations()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the operations Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#close">close()</a></code></p> |
| 94 | <p class="firstline">Close httplib2 connections.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Gets information about a location.</p> |
| 98 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 99 | <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | <p class="firstline">Lists information about the supported locations for this service.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
| 106 | <code class="details" id="close">close()</code> |
| 107 | <pre>Close httplib2 connections.</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
| 111 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 112 | <pre>Gets information about a location. |
| 113 | |
| 114 | Args: |
| 115 | name: string, Resource name for the location. (required) |
| 116 | x__xgafv: string, V1 error format. |
| 117 | Allowed values |
| 118 | 1 - v1 error format |
| 119 | 2 - v2 error format |
| 120 | |
| 121 | Returns: |
| 122 | An object of the form: |
| 123 | |
| 124 | { # A resource that represents Google Cloud Platform location. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 125 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 126 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 127 | "a_key": "A String", |
| 128 | }, |
| 129 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 130 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 131 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 132 | }, |
| 133 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 134 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 135 | </div> |
| 136 | |
| 137 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 138 | <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 139 | <pre>Lists information about the supported locations for this service. |
| 140 | |
| 141 | Args: |
| 142 | name: string, The resource that owns the locations collection, if applicable. (required) |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 143 | filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 144 | pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 145 | pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 146 | x__xgafv: string, V1 error format. |
| 147 | Allowed values |
| 148 | 1 - v1 error format |
| 149 | 2 - v2 error format |
| 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { # The response message for Locations.ListLocations. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 155 | "locations": [ # A list of locations that matches the specified filter in the request. |
| 156 | { # A resource that represents Google Cloud Platform location. |
| 157 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 158 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 159 | "a_key": "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 160 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 161 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 162 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 163 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 164 | }, |
| 165 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 166 | }, |
| 167 | ], |
| 168 | "nextPageToken": "A String", # The standard List next-page token. |
| 169 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 170 | </div> |
| 171 | |
| 172 | <div class="method"> |
| 173 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 174 | <pre>Retrieves the next page of results. |
| 175 | |
| 176 | Args: |
| 177 | previous_request: The request for the previous page. (required) |
| 178 | previous_response: The response from the request for the previous page. (required) |
| 179 | |
| 180 | Returns: |
| 181 | A request object that you can call 'execute()' on to request the next |
| 182 | page. Returns None if there are no more items in the collection. |
| 183 | </pre> |
| 184 | </div> |
| 185 | |
| 186 | </body></html> |