| 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> . <a href="bigquerydatatransfer_v1.projects.locations.dataSources.html">dataSources</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Returns true if valid credentials exist for the given data source and</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Retrieves a supported data source and returns its settings,</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 84 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists supported data sources and returns their settings,</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"> |
| 91 | <code class="details" id="checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</code> |
| 92 | <pre>Returns true if valid credentials exist for the given data source and |
| 93 | requesting user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | Some data sources doesn't support service account, so we need to talk to |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | them on behalf of the end user. This API just checks whether we have OAuth |
| 96 | token for the particular user, which is a pre-requisite before user can |
| 97 | create a transfer config. |
| 98 | |
| 99 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 100 | name: string, Required. The data source in the form: |
| 101 | `projects/{project_id}/dataSources/{data_source_id}` or |
| 102 | `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | body: object, The request body. |
| 104 | The object takes the form of: |
| 105 | |
| 106 | { # A request to determine whether the user has valid credentials. This method |
| 107 | # is used to limit the number of OAuth popups in the user interface. The |
| 108 | # user id is inferred from the API call context. |
| 109 | # If the data source has the Google+ authorization type, this method |
| 110 | # returns false, as it cannot be determined whether the credentials are |
| 111 | # already valid merely based on the user id. |
| 112 | } |
| 113 | |
| 114 | x__xgafv: string, V1 error format. |
| 115 | Allowed values |
| 116 | 1 - v1 error format |
| 117 | 2 - v2 error format |
| 118 | |
| 119 | Returns: |
| 120 | An object of the form: |
| 121 | |
| 122 | { # A response indicating whether the credentials exist and are valid. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "hasValidCreds": True or False, # If set to `true`, the credentials exist and are valid. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | }</pre> |
| 125 | </div> |
| 126 | |
| 127 | <div class="method"> |
| 128 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 129 | <pre>Retrieves a supported data source and returns its settings, |
| 130 | which can be used for UI rendering. |
| 131 | |
| 132 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | name: string, Required. The field will contain name of the resource requested, for example: |
| 134 | `projects/{project_id}/dataSources/{data_source_id}` or |
| 135 | `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | x__xgafv: string, V1 error format. |
| 137 | Allowed values |
| 138 | 1 - v1 error format |
| 139 | 2 - v2 error format |
| 140 | |
| 141 | Returns: |
| 142 | An object of the form: |
| 143 | |
| 144 | { # Represents data source metadata. Metadata is sufficient to |
| 145 | # render UI and request proper OAuth tokens. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | "dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the |
| 147 | # past few days, and how it's supported. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | # For some data sources, data might not be complete until a few days later, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | # so it's useful to refresh data automatically. |
| 150 | "parameters": [ # Data source parameters. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 151 | { # Represents a data source parameter with validation rules, so that |
| 152 | # parameters can be rendered in the UI. These parameters are given to us by |
| 153 | # supported data sources, and include all needed information for rendering |
| 154 | # and validation. |
| 155 | # Thus, whoever uses this api can decide to generate either generic ui, |
| 156 | # or custom data source specific forms. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | "allowedValues": [ # All possible values for the parameter. |
| 158 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 159 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "minValue": 3.14, # For integer and double values specifies minimum allowed value. |
| 161 | "validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements. |
| 162 | "validationRegex": "A String", # Regular expression which can be used for parameter validation. |
| 163 | "paramId": "A String", # Parameter identifier. |
| 164 | "required": True or False, # Is parameter required. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 165 | "repeated": True or False, # Deprecated. This field has no effect. |
| 166 | "displayName": "A String", # Parameter display name in the user interface. |
| 167 | "validationDescription": "A String", # Description of the requirements for this field, in case the user input does |
| 168 | # not fulfill the regex pattern or min/max values. |
| 169 | "immutable": True or False, # Cannot be changed after initial creation. |
| 170 | "deprecated": True or False, # If true, it should not be used in new transfers, and it should not be |
| 171 | # visible to users. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 172 | "fields": [ # Deprecated. This field has no effect. |
| 173 | # Object with schema name: DataSourceParameter |
| 174 | ], |
| 175 | "maxValue": 3.14, # For integer and double values specifies maxminum allowed value. |
| 176 | "type": "A String", # Parameter type. |
| 177 | "recurse": True or False, # Deprecated. This field has no effect. |
| 178 | "description": "A String", # Parameter description. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 179 | }, |
| 180 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | "helpUrl": "A String", # Url for the help document for this data source. |
| 182 | "defaultSchedule": "A String", # Default data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 183 | # Examples of valid schedules include: |
| 184 | # `1st,3rd monday of month 15:30`, |
| 185 | # `every wed,fri of jan,jun 13:15`, and |
| 186 | # `first sunday of quarter 00:00`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | "supportsMultipleTransfers": True or False, # Deprecated. This field has no effect. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 188 | "defaultDataRefreshWindowDays": 42, # Default data refresh window on days. |
| 189 | # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 190 | "manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling |
| 191 | # for the data source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | "transferType": "A String", # Deprecated. This field has no effect. |
| 193 | "description": "A String", # User friendly data source description string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 194 | "dataSourceId": "A String", # Data source id. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 195 | "scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are |
| 196 | # scopes needed by a data source to prepare data and ingest them into |
| 197 | # BigQuery, e.g., https://www.googleapis.com/auth/bigquery |
| 198 | "A String", |
| 199 | ], |
| 200 | "name": "A String", # Output only. Data source resource name. |
| 201 | "minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs. |
| 202 | "clientId": "A String", # Data source client id which should be used to receive refresh token. |
| 203 | "authorizationType": "A String", # Indicates the type of authorization. |
| 204 | "supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or |
| 205 | # operates on the default schedule. |
| 206 | # When set to `true`, user can override default schedule. |
| 207 | "displayName": "A String", # User friendly data source name. |
| 208 | "updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source |
| 209 | # before the Data Transfer Service marks the transfer as FAILED. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 210 | }</pre> |
| 211 | </div> |
| 212 | |
| 213 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 214 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 215 | <pre>Lists supported data sources and returns their settings, |
| 216 | which can be used for UI rendering. |
| 217 | |
| 218 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 219 | parent: string, Required. The BigQuery project id for which data sources should be returned. |
| 220 | Must be in the form: `projects/{project_id}` or |
| 221 | `projects/{project_id}/locations/{location_id} (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 222 | pageToken: string, Pagination token, which can be used to request a specific page |
| 223 | of `ListDataSourcesRequest` list results. For multiple-page |
| 224 | results, `ListDataSourcesResponse` outputs |
| 225 | a `next_page` token, which can be used as the |
| 226 | `page_token` value to request the next page of list results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 227 | pageSize: integer, Page size. The default page size is the maximum value of 1000 results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 228 | x__xgafv: string, V1 error format. |
| 229 | Allowed values |
| 230 | 1 - v1 error format |
| 231 | 2 - v2 error format |
| 232 | |
| 233 | Returns: |
| 234 | An object of the form: |
| 235 | |
| 236 | { # Returns list of supported data sources and their metadata. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "dataSources": [ # List of supported data sources and their transfer settings. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | { # Represents data source metadata. Metadata is sufficient to |
| 239 | # render UI and request proper OAuth tokens. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 240 | "dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the |
| 241 | # past few days, and how it's supported. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 242 | # For some data sources, data might not be complete until a few days later, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | # so it's useful to refresh data automatically. |
| 244 | "parameters": [ # Data source parameters. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 245 | { # Represents a data source parameter with validation rules, so that |
| 246 | # parameters can be rendered in the UI. These parameters are given to us by |
| 247 | # supported data sources, and include all needed information for rendering |
| 248 | # and validation. |
| 249 | # Thus, whoever uses this api can decide to generate either generic ui, |
| 250 | # or custom data source specific forms. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | "allowedValues": [ # All possible values for the parameter. |
| 252 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 253 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | "minValue": 3.14, # For integer and double values specifies minimum allowed value. |
| 255 | "validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements. |
| 256 | "validationRegex": "A String", # Regular expression which can be used for parameter validation. |
| 257 | "paramId": "A String", # Parameter identifier. |
| 258 | "required": True or False, # Is parameter required. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 259 | "repeated": True or False, # Deprecated. This field has no effect. |
| 260 | "displayName": "A String", # Parameter display name in the user interface. |
| 261 | "validationDescription": "A String", # Description of the requirements for this field, in case the user input does |
| 262 | # not fulfill the regex pattern or min/max values. |
| 263 | "immutable": True or False, # Cannot be changed after initial creation. |
| 264 | "deprecated": True or False, # If true, it should not be used in new transfers, and it should not be |
| 265 | # visible to users. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 266 | "fields": [ # Deprecated. This field has no effect. |
| 267 | # Object with schema name: DataSourceParameter |
| 268 | ], |
| 269 | "maxValue": 3.14, # For integer and double values specifies maxminum allowed value. |
| 270 | "type": "A String", # Parameter type. |
| 271 | "recurse": True or False, # Deprecated. This field has no effect. |
| 272 | "description": "A String", # Parameter description. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 273 | }, |
| 274 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "helpUrl": "A String", # Url for the help document for this data source. |
| 276 | "defaultSchedule": "A String", # Default data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 277 | # Examples of valid schedules include: |
| 278 | # `1st,3rd monday of month 15:30`, |
| 279 | # `every wed,fri of jan,jun 13:15`, and |
| 280 | # `first sunday of quarter 00:00`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 281 | "supportsMultipleTransfers": True or False, # Deprecated. This field has no effect. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 282 | "defaultDataRefreshWindowDays": 42, # Default data refresh window on days. |
| 283 | # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 284 | "manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling |
| 285 | # for the data source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | "transferType": "A String", # Deprecated. This field has no effect. |
| 287 | "description": "A String", # User friendly data source description string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 288 | "dataSourceId": "A String", # Data source id. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 289 | "scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are |
| 290 | # scopes needed by a data source to prepare data and ingest them into |
| 291 | # BigQuery, e.g., https://www.googleapis.com/auth/bigquery |
| 292 | "A String", |
| 293 | ], |
| 294 | "name": "A String", # Output only. Data source resource name. |
| 295 | "minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs. |
| 296 | "clientId": "A String", # Data source client id which should be used to receive refresh token. |
| 297 | "authorizationType": "A String", # Indicates the type of authorization. |
| 298 | "supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or |
| 299 | # operates on the default schedule. |
| 300 | # When set to `true`, user can override default schedule. |
| 301 | "displayName": "A String", # User friendly data source name. |
| 302 | "updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source |
| 303 | # before the Data Transfer Service marks the transfer as FAILED. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 304 | }, |
| 305 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results, |
| 307 | # this token can be used as the |
| 308 | # `ListDataSourcesRequest.page_token` |
| 309 | # to request the next page of list results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 310 | }</pre> |
| 311 | </div> |
| 312 | |
| 313 | <div class="method"> |
| 314 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 315 | <pre>Retrieves the next page of results. |
| 316 | |
| 317 | Args: |
| 318 | previous_request: The request for the previous page. (required) |
| 319 | previous_response: The response from the request for the previous page. (required) |
| 320 | |
| 321 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 322 | 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] | 323 | page. Returns None if there are no more items in the collection. |
| 324 | </pre> |
| 325 | </div> |
| 326 | |
| 327 | </body></html> |