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