Blame - docs/dyn/bigquerydatatransfer_v1.projects.dataSources.html - platform/external/python/google-api-python-client

blob: f33be4efbbec392c83271a211a077f931abd86c4 [file] [log] [blame]

Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[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
Bu Sun Kim	715bd7f	2019-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 Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	78	<code><a href="#checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-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>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-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>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	86	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	87	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-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>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[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">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<code class="details" id="checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-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'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.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	96
				97	Args:
Dmitry Frenkel	3e17f89	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	99	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	100	The object takes the form of:
				101
Dmitry Frenkel	3e17f89	2020-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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	103	}
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	104
				105	x__xgafv: string, V1 error format.
				106	Allowed values
				107	1 - v1 error format
				108	2 - v2 error format
				109
				110	Returns:
				111	An object of the form:
				112
				113	{ # A response indicating whether the credentials exist and are valid.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	114	"hasValidCreds": True or False, # If set to `true`, the credentials exist and are valid.
				115	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	116	</div>
				117
				118	<div class="method">
Dmitry Frenkel	3e17f89	2020-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">
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	124	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-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.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	126
				127	Args:
Dmitry Frenkel	3e17f89	2020-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)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
				133
				134	Returns:
				135	An object of the form:
				136
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	{ # Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	"authorizationType": "A String", # Indicates the type of authorization.
				139	"clientId": "A String", # Data source client id which should be used to receive refresh token.
				140	"dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
				141	"dataSourceId": "A String", # Data source id.
				142	"defaultDataRefreshWindowDays": 42, # Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
				143	"defaultSchedule": "A String", # 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`.
				144	"description": "A String", # User friendly data source description string.
				145	"displayName": "A String", # User friendly data source name.
				146	"helpUrl": "A String", # Url for the help document for this data source.
				147	"manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling for the data source.
				148	"minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.
				149	"name": "A String", # Output only. Data source resource name.
				150	"parameters": [ # Data source parameters.
				151	{ # 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.
				152	"allowedValues": [ # All possible values for the parameter.
				153	"A String",
				154	],
				155	"deprecated": True or False, # If true, it should not be used in new transfers, and it should not be visible to users.
				156	"description": "A String", # Parameter description.
				157	"displayName": "A String", # Parameter display name in the user interface.
				158	"fields": [ # Deprecated. This field has no effect.
				159	# Object with schema name: DataSourceParameter
				160	],
				161	"immutable": True or False, # Cannot be changed after initial creation.
				162	"maxValue": 3.14, # For integer and double values specifies maxminum allowed value.
				163	"minValue": 3.14, # For integer and double values specifies minimum allowed value.
				164	"paramId": "A String", # Parameter identifier.
				165	"recurse": True or False, # Deprecated. This field has no effect.
				166	"repeated": True or False, # Deprecated. This field has no effect.
				167	"required": True or False, # Is parameter required.
				168	"type": "A String", # Parameter type.
				169	"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
				170	"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
				171	"validationRegex": "A String", # Regular expression which can be used for parameter validation.
				172	},
				173	],
				174	"scopes": [ # 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
				175	"A String",
				176	],
				177	"supportsCustomSchedule": 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.
				178	"supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.
				179	"transferType": "A String", # Deprecated. This field has no effect.
				180	"updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
				181	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	182	</div>
				183
				184	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	185	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-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.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	187
				188	Args:
Dmitry Frenkel	3e17f89	2020-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)
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	190	pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	191	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.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	192	x__xgafv: string, V1 error format.
				193	Allowed values
				194	1 - v1 error format
				195	2 - v2 error format
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	196
				197	Returns:
				198	An object of the form:
				199
				200	{ # Returns list of supported data sources and their metadata.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	201	"dataSources": [ # List of supported data sources and their transfer settings.
				202	{ # Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
				203	"authorizationType": "A String", # Indicates the type of authorization.
				204	"clientId": "A String", # Data source client id which should be used to receive refresh token.
				205	"dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
				206	"dataSourceId": "A String", # Data source id.
				207	"defaultDataRefreshWindowDays": 42, # Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
				208	"defaultSchedule": "A String", # 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`.
				209	"description": "A String", # User friendly data source description string.
				210	"displayName": "A String", # User friendly data source name.
				211	"helpUrl": "A String", # Url for the help document for this data source.
				212	"manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling for the data source.
				213	"minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.
				214	"name": "A String", # Output only. Data source resource name.
				215	"parameters": [ # Data source parameters.
				216	{ # 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.
				217	"allowedValues": [ # All possible values for the parameter.
				218	"A String",
				219	],
				220	"deprecated": True or False, # If true, it should not be used in new transfers, and it should not be visible to users.
				221	"description": "A String", # Parameter description.
				222	"displayName": "A String", # Parameter display name in the user interface.
				223	"fields": [ # Deprecated. This field has no effect.
				224	# Object with schema name: DataSourceParameter
				225	],
				226	"immutable": True or False, # Cannot be changed after initial creation.
				227	"maxValue": 3.14, # For integer and double values specifies maxminum allowed value.
				228	"minValue": 3.14, # For integer and double values specifies minimum allowed value.
				229	"paramId": "A String", # Parameter identifier.
				230	"recurse": True or False, # Deprecated. This field has no effect.
				231	"repeated": True or False, # Deprecated. This field has no effect.
				232	"required": True or False, # Is parameter required.
				233	"type": "A String", # Parameter type.
				234	"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
				235	"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
				236	"validationRegex": "A String", # Regular expression which can be used for parameter validation.
				237	},
				238	],
				239	"scopes": [ # 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
				240	"A String",
				241	],
				242	"supportsCustomSchedule": 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.
				243	"supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.
				244	"transferType": "A String", # Deprecated. This field has no effect.
				245	"updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
				246	},
				247	],
				248	"nextPageToken": "A String", # 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.
				249	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	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
				256	Args:
				257	previous_request: The request for the previous page. (required)
				258	previous_response: The response from the request for the previous page. (required)
				259
				260	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	261	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	262	page. Returns None if there are no more items in the collection.
				263	</pre>
				264	</div>
				265
				266	</body></html>