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