public sealed class DataSource : IMessage<DataSource>, IEquatable<DataSource>, IDeepCloneable<DataSource>, IBufferMessage, IMessageReference documentation and code samples for the Google BigQuery Data Transfer v1 API class DataSource.
Defines the properties and custom parameters for a data source.
Implements
IMessageDataSource, IEquatableDataSource, IDeepCloneableDataSource, IBufferMessage, IMessageNamespace
Google.Cloud.BigQuery.DataTransfer.V1Assembly
Google.Cloud.BigQuery.DataTransfer.V1.dll
Constructors
DataSource()
public DataSource()DataSource(DataSource)
public DataSource(DataSource other)| Parameter | |
|---|---|
| Name | Description |
other |
DataSource |
Properties
AuthorizationType
public DataSource.Types.AuthorizationType AuthorizationType { get; set; }Indicates the type of authorization.
| Property Value | |
|---|---|
| Type | Description |
DataSourceTypesAuthorizationType |
|
ClientId
public string ClientId { get; set; }Data source client id which should be used to receive refresh token.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DataRefreshType
public DataSource.Types.DataRefreshType DataRefreshType { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DataSourceTypesDataRefreshType |
|
DataSourceId
public string DataSourceId { get; set; }Data source id.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DataSourceName
public DataSourceName DataSourceName { get; set; }DataSourceName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DataSourceName |
|
DefaultDataRefreshWindowDays
public int DefaultDataRefreshWindowDays { get; set; }Default data refresh window on days.
Only meaningful when data_refresh_type = SLIDING_WINDOW.
| Property Value | |
|---|---|
| Type | Description |
int |
|
DefaultSchedule
public string DefaultSchedule { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Description
public string Description { get; set; }User friendly data source description string.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }User friendly data source name.
| Property Value | |
|---|---|
| Type | Description |
string |
|
HelpUrl
public string HelpUrl { get; set; }Url for the help document for this data source.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ManualRunsDisabled
public bool ManualRunsDisabled { get; set; }Disables backfilling and manual run scheduling for the data source.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
MinimumScheduleInterval
public Duration MinimumScheduleInterval { get; set; }The minimum interval for scheduler to schedule runs.
| Property Value | |
|---|---|
| Type | Description |
Duration |
|
Name
public string Name { get; set; }Output only. Data source resource name.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Parameters
public RepeatedField<DataSourceParameter> Parameters { get; }Data source parameters.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDataSourceParameter |
|
Scopes
public RepeatedField<string> Scopes { get; }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
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
SupportsCustomSchedule
public bool SupportsCustomSchedule { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SupportsMultipleTransfers
[Obsolete]
public bool SupportsMultipleTransfers { get; set; }Deprecated. This field has no effect.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
TransferType
[Obsolete]
public TransferType TransferType { get; set; }Deprecated. This field has no effect.
| Property Value | |
|---|---|
| Type | Description |
TransferType |
|
UpdateDeadlineSeconds
public int UpdateDeadlineSeconds { get; set; }The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
| Property Value | |
|---|---|
| Type | Description |
int |
|