| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -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="bigquerydatatransfer_v1.html">BigQuery Data Transfer API</a> . <a href="bigquerydatatransfer_v1.projects.html">projects</a> . <a href="bigquerydatatransfer_v1.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="bigquerydatatransfer_v1.projects.locations.dataSources.html">dataSources()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the dataSources Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.html">transferConfigs()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the transferConfigs Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <code><a href="#close">close()</a></code></p> |
| 89 | <p class="firstline">Close httplib2 connections.</p> |
| 90 | <p class="toc_element"> |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame^] | 91 | <code><a href="#enrollDataSources">enrollDataSources(name, body=None, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).</p> |
| 93 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Gets information about a location.</p> |
| 96 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 97 | <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="firstline">Lists information about the supported locations for this service.</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 101 | <p class="firstline">Retrieves the next page of results.</p> |
| 102 | <h3>Method Details</h3> |
| 103 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 104 | <code class="details" id="close">close()</code> |
| 105 | <pre>Close httplib2 connections.</pre> |
| 106 | </div> |
| 107 | |
| 108 | <div class="method"> |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame^] | 109 | <code class="details" id="enrollDataSources">enrollDataSources(name, body=None, x__xgafv=None)</code> |
| 110 | <pre>Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers). |
| 111 | |
| 112 | Args: |
| 113 | name: string, The name of the project resource in the form: `projects/{project_id}` (required) |
| 114 | body: object, The request body. |
| 115 | The object takes the form of: |
| 116 | |
| 117 | { # A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab. |
| 118 | "dataSourceIds": [ # Data sources that are enrolled. It is required to provide at least one data source id. |
| 119 | "A String", |
| 120 | ], |
| 121 | } |
| 122 | |
| 123 | x__xgafv: string, V1 error format. |
| 124 | Allowed values |
| 125 | 1 - v1 error format |
| 126 | 2 - v2 error format |
| 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 132 | }</pre> |
| 133 | </div> |
| 134 | |
| 135 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 137 | <pre>Gets information about a location. |
| 138 | |
| 139 | Args: |
| 140 | name: string, Resource name for the location. (required) |
| 141 | x__xgafv: string, V1 error format. |
| 142 | Allowed values |
| 143 | 1 - v1 error format |
| 144 | 2 - v2 error format |
| 145 | |
| 146 | Returns: |
| 147 | An object of the form: |
| 148 | |
| 149 | { # A resource that represents Google Cloud Platform location. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 150 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 151 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 152 | "a_key": "A String", |
| 153 | }, |
| 154 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 155 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 156 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 157 | }, |
| 158 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 159 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 160 | </div> |
| 161 | |
| 162 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 163 | <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 164 | <pre>Lists information about the supported locations for this service. |
| 165 | |
| 166 | Args: |
| 167 | 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] | 168 | 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). |
| yoshi-code-bot | f0c2fa6 | 2021-04-23 08:24:04 -0700 | [diff] [blame] | 169 | 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] | 170 | pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 171 | x__xgafv: string, V1 error format. |
| 172 | Allowed values |
| 173 | 1 - v1 error format |
| 174 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 175 | |
| 176 | Returns: |
| 177 | An object of the form: |
| 178 | |
| 179 | { # The response message for Locations.ListLocations. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 180 | "locations": [ # A list of locations that matches the specified filter in the request. |
| 181 | { # A resource that represents Google Cloud Platform location. |
| 182 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 183 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 184 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 186 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 187 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 188 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 189 | }, |
| 190 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 191 | }, |
| 192 | ], |
| 193 | "nextPageToken": "A String", # The standard List next-page token. |
| 194 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 195 | </div> |
| 196 | |
| 197 | <div class="method"> |
| 198 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 199 | <pre>Retrieves the next page of results. |
| 200 | |
| 201 | Args: |
| 202 | previous_request: The request for the previous page. (required) |
| 203 | previous_response: The response from the request for the previous page. (required) |
| 204 | |
| 205 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 206 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 207 | page. Returns None if there are no more items in the collection. |
| 208 | </pre> |
| 209 | </div> |
| 210 | |
| 211 | </body></html> |