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