| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [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="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 78 | <code><a href="datastream_v1.projects.locations.connectionProfiles.html">connectionProfiles()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the connectionProfiles Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 83 | <code><a href="datastream_v1.projects.locations.operations.html">operations()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the operations Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 88 | <code><a href="datastream_v1.projects.locations.privateConnections.html">privateConnections()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the privateConnections Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="datastream_v1.projects.locations.streams.html">streams()</a></code> |
| 94 | </p> |
| 95 | <p class="firstline">Returns the streams Resource.</p> |
| 96 | |
| 97 | <p class="toc_element"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 98 | <code><a href="#close">close()</a></code></p> |
| 99 | <p class="firstline">Close httplib2 connections.</p> |
| 100 | <p class="toc_element"> |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 101 | <code><a href="#fetchStaticIps">fetchStaticIps(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">The FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#fetchStaticIps_next">fetchStaticIps_next(previous_request, previous_response)</a></code></p> |
| 105 | <p class="firstline">Retrieves the next page of results.</p> |
| 106 | <p class="toc_element"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 107 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 108 | <p class="firstline">Gets information about a location.</p> |
| 109 | <p class="toc_element"> |
| 110 | <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 111 | <p class="firstline">Lists information about the supported locations for this service.</p> |
| 112 | <p class="toc_element"> |
| 113 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 114 | <p class="firstline">Retrieves the next page of results.</p> |
| 115 | <h3>Method Details</h3> |
| 116 | <div class="method"> |
| 117 | <code class="details" id="close">close()</code> |
| 118 | <pre>Close httplib2 connections.</pre> |
| 119 | </div> |
| 120 | |
| 121 | <div class="method"> |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 122 | <code class="details" id="fetchStaticIps">fetchStaticIps(name, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 123 | <pre>The FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request. |
| 124 | |
| 125 | Args: |
| 126 | name: string, Required. The name resource of the Response type. Must be in the format `projects/*/locations/*`. (required) |
| 127 | pageSize: integer, Maximum number of Ips to return, will likely not be specified. |
| 128 | pageToken: string, A page token, received from a previous `ListStaticIps` call. will likely not be specified. |
| 129 | x__xgafv: string, V1 error format. |
| 130 | Allowed values |
| 131 | 1 - v1 error format |
| 132 | 2 - v2 error format |
| 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { # Response message for a 'FetchStaticIps' response. |
| 138 | "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 139 | "staticIps": [ # list of static ips by account |
| 140 | "A String", |
| 141 | ], |
| 142 | }</pre> |
| 143 | </div> |
| 144 | |
| 145 | <div class="method"> |
| 146 | <code class="details" id="fetchStaticIps_next">fetchStaticIps_next(previous_request, previous_response)</code> |
| 147 | <pre>Retrieves the next page of results. |
| 148 | |
| 149 | Args: |
| 150 | previous_request: The request for the previous page. (required) |
| 151 | previous_response: The response from the request for the previous page. (required) |
| 152 | |
| 153 | Returns: |
| 154 | A request object that you can call 'execute()' on to request the next |
| 155 | page. Returns None if there are no more items in the collection. |
| 156 | </pre> |
| 157 | </div> |
| 158 | |
| 159 | <div class="method"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 160 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 161 | <pre>Gets information about a location. |
| 162 | |
| 163 | Args: |
| 164 | name: string, Resource name for the location. (required) |
| 165 | x__xgafv: string, V1 error format. |
| 166 | Allowed values |
| 167 | 1 - v1 error format |
| 168 | 2 - v2 error format |
| 169 | |
| 170 | Returns: |
| 171 | An object of the form: |
| 172 | |
| 173 | { # A resource that represents Google Cloud Platform location. |
| 174 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 175 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 176 | "a_key": "A String", |
| 177 | }, |
| 178 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 179 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 180 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 181 | }, |
| 182 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 183 | }</pre> |
| 184 | </div> |
| 185 | |
| 186 | <div class="method"> |
| 187 | <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 188 | <pre>Lists information about the supported locations for this service. |
| 189 | |
| 190 | Args: |
| 191 | name: string, The resource that owns the locations collection, if applicable. (required) |
| 192 | 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). |
| 193 | pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| 194 | pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
| 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
| 203 | { # The response message for Locations.ListLocations. |
| 204 | "locations": [ # A list of locations that matches the specified filter in the request. |
| 205 | { # A resource that represents Google Cloud Platform location. |
| 206 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 207 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 208 | "a_key": "A String", |
| 209 | }, |
| 210 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 211 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 212 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 213 | }, |
| 214 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 215 | }, |
| 216 | ], |
| 217 | "nextPageToken": "A String", # The standard List next-page token. |
| 218 | }</pre> |
| 219 | </div> |
| 220 | |
| 221 | <div class="method"> |
| 222 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 223 | <pre>Retrieves the next page of results. |
| 224 | |
| 225 | Args: |
| 226 | previous_request: The request for the previous page. (required) |
| 227 | previous_response: The response from the request for the previous page. (required) |
| 228 | |
| 229 | Returns: |
| 230 | A request object that you can call 'execute()' on to request the next |
| 231 | page. Returns None if there are no more items in the collection. |
| 232 | </pre> |
| 233 | </div> |
| 234 | |
| 235 | </body></html> |