Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / bigquerydatatransfer_v1.projects.dataSources.html
blob: e53f4322994ee2570ed14cac859551b81a51daf7 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.dataSources.html">dataSources</a></h1>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]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">
84 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <code class="details" id="checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]92 <pre>Returns true if valid credentials exist for the given data source and
93requesting user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94Some data sources doesn't support service account, so we need to talk to
95them on behalf of the end user. This API just checks whether we have OAuth
96token for the particular user, which is a pre-requisite before user can
97create a transfer config.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]98
99Args:
Dan O'Mearadd494642020-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]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
119Returns:
120 An object of the form:
121
122 { # A response indicating whether the credentials exist and are valid.
123 "hasValidCreds": True or False, # If set to `true`, the credentials exist and are valid.
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,
130which can be used for UI rendering.
131
132Args:
Dan O'Mearadd494642020-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)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 "scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are
147 # scopes needed by a data source to prepare data and ingest them into
148 # BigQuery, e.g., https://www.googleapis.com/auth/bigquery
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]149 "A String",
150 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 "minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.
152 "supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or
153 # operates on the default schedule.
154 # When set to `true`, user can override default schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]155 "dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the
156 # past few days, and how it's supported.
157 # For some data sources, data might not be complete until a few days later,
158 # so it's useful to refresh data automatically.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]159 "parameters": [ # Data source parameters.
160 { # Represents a data source parameter with validation rules, so that
161 # parameters can be rendered in the UI. These parameters are given to us by
162 # supported data sources, and include all needed information for rendering
163 # and validation.
164 # Thus, whoever uses this api can decide to generate either generic ui,
165 # or custom data source specific forms.
166 "paramId": "A String", # Parameter identifier.
167 "displayName": "A String", # Parameter display name in the user interface.
168 "description": "A String", # Parameter description.
169 "validationDescription": "A String", # Description of the requirements for this field, in case the user input does
170 # not fulfill the regex pattern or min/max values.
171 "deprecated": True or False, # If true, it should not be used in new transfers, and it should not be
172 # visible to users.
173 "required": True or False, # Is parameter required.
174 "recurse": True or False, # Deprecated. This field has no effect.
175 "maxValue": 3.14, # For integer and double values specifies maxminum allowed value.
176 "minValue": 3.14, # For integer and double values specifies minimum allowed value.
177 "repeated": True or False, # Deprecated. This field has no effect.
178 "fields": [ # Deprecated. This field has no effect.
179 # Object with schema name: DataSourceParameter
180 ],
181 "validationRegex": "A String", # Regular expression which can be used for parameter validation.
182 "validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
183 "allowedValues": [ # All possible values for the parameter.
184 "A String",
185 ],
186 "type": "A String", # Parameter type.
187 "immutable": True or False, # Cannot be changed after initial creation.
188 },
189 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]190 "description": "A String", # User friendly data source description string.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]191 "manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling
192 # for the data source.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]193 "name": "A String", # Output only. Data source resource name.
194 "clientId": "A String", # Data source client id which should be used to receive refresh token.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]195 "defaultSchedule": "A String", # Default data transfer schedule.
196 # Examples of valid schedules include:
197 # `1st,3rd monday of month 15:30`,
198 # `every wed,fri of jan,jun 13:15`, and
199 # `first sunday of quarter 00:00`.
200 "dataSourceId": "A String", # Data source id.
201 "defaultDataRefreshWindowDays": 42, # Default data refresh window on days.
202 # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 "displayName": "A String", # User friendly data source name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]204 "supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.
205 "helpUrl": "A String", # Url for the help document for this data source.
206 "authorizationType": "A String", # Indicates the type of authorization.
207 "updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source
208 # before the Data Transfer Service marks the transfer as FAILED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 "transferType": "A String", # Deprecated. This field has no effect.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
215 <pre>Lists supported data sources and returns their settings,
216which can be used for UI rendering.
217
218Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]219 parent: string, Required. The BigQuery project id for which data sources should be returned.
220Must be in the form: `projects/{project_id}` or
221`projects/{project_id}/locations/{location_id} (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]222 pageToken: string, Pagination token, which can be used to request a specific page
223of `ListDataSourcesRequest` list results. For multiple-page
224results, `ListDataSourcesResponse` outputs
225a `next_page` token, which can be used as the
226`page_token` value to request the next page of list results.
227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
231 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
232
233Returns:
234 An object of the form:
235
236 { # Returns list of supported data sources and their metadata.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]238 # this token can be used as the
239 # `ListDataSourcesRequest.page_token`
240 # to request the next page of list results.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]241 "dataSources": [ # List of supported data sources and their transfer settings.
242 { # Represents data source metadata. Metadata is sufficient to
243 # render UI and request proper OAuth tokens.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are
245 # scopes needed by a data source to prepare data and ingest them into
246 # BigQuery, e.g., https://www.googleapis.com/auth/bigquery
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]247 "A String",
248 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.
250 "supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or
251 # operates on the default schedule.
252 # When set to `true`, user can override default schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]253 "dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the
254 # past few days, and how it's supported.
255 # For some data sources, data might not be complete until a few days later,
256 # so it's useful to refresh data automatically.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]257 "parameters": [ # Data source parameters.
258 { # Represents a data source parameter with validation rules, so that
259 # parameters can be rendered in the UI. These parameters are given to us by
260 # supported data sources, and include all needed information for rendering
261 # and validation.
262 # Thus, whoever uses this api can decide to generate either generic ui,
263 # or custom data source specific forms.
264 "paramId": "A String", # Parameter identifier.
265 "displayName": "A String", # Parameter display name in the user interface.
266 "description": "A String", # Parameter description.
267 "validationDescription": "A String", # Description of the requirements for this field, in case the user input does
268 # not fulfill the regex pattern or min/max values.
269 "deprecated": True or False, # If true, it should not be used in new transfers, and it should not be
270 # visible to users.
271 "required": True or False, # Is parameter required.
272 "recurse": True or False, # Deprecated. This field has no effect.
273 "maxValue": 3.14, # For integer and double values specifies maxminum allowed value.
274 "minValue": 3.14, # For integer and double values specifies minimum allowed value.
275 "repeated": True or False, # Deprecated. This field has no effect.
276 "fields": [ # Deprecated. This field has no effect.
277 # Object with schema name: DataSourceParameter
278 ],
279 "validationRegex": "A String", # Regular expression which can be used for parameter validation.
280 "validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
281 "allowedValues": [ # All possible values for the parameter.
282 "A String",
283 ],
284 "type": "A String", # Parameter type.
285 "immutable": True or False, # Cannot be changed after initial creation.
286 },
287 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]288 "description": "A String", # User friendly data source description string.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]289 "manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling
290 # for the data source.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]291 "name": "A String", # Output only. Data source resource name.
292 "clientId": "A String", # Data source client id which should be used to receive refresh token.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]293 "defaultSchedule": "A String", # Default data transfer schedule.
294 # Examples of valid schedules include:
295 # `1st,3rd monday of month 15:30`,
296 # `every wed,fri of jan,jun 13:15`, and
297 # `first sunday of quarter 00:00`.
298 "dataSourceId": "A String", # Data source id.
299 "defaultDataRefreshWindowDays": 42, # Default data refresh window on days.
300 # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 "displayName": "A String", # User friendly data source name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]302 "supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.
303 "helpUrl": "A String", # Url for the help document for this data source.
304 "authorizationType": "A String", # Indicates the type of authorization.
305 "updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source
306 # before the Data Transfer Service marks the transfer as FAILED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 "transferType": "A String", # Deprecated. This field has no effect.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]308 },
309 ],
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
317Args:
318 previous_request: The request for the previous page. (required)
319 previous_response: The response from the request for the previous page. (required)
320
321Returns:
322 A request object that you can call 'execute()' on to request the next
323 page. Returns None if there are no more items in the collection.
324 </pre>
325</div>
326
327</body></html>