BigQuery Data Transfer V1 Client - Class DataSource (1.4.5)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class DataSource.

Defines the properties and custom parameters for a data source.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.DataSource

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Data source resource name.

↳ data_source_id string

Data source id.

↳ display_name string

User friendly data source name.

↳ description string

User friendly data source description string.

↳ client_id string

Data source client id which should be used to receive refresh token.

↳ scopes array

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

↳ transfer_type int

Deprecated. This field has no effect.

↳ supports_multiple_transfers bool

Deprecated. This field has no effect.

↳ update_deadline_seconds int

The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

↳ default_schedule 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.

↳ supports_custom_schedule bool

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.

↳ parameters array<Google\Cloud\BigQuery\DataTransfer\V1\DataSourceParameter>

Data source parameters.

↳ help_url string

Url for the help document for this data source.

↳ authorization_type int

Indicates the type of authorization.

↳ data_refresh_type int

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.

↳ default_data_refresh_window_days int

Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.

↳ manual_runs_disabled bool

Disables backfilling and manual run scheduling for the data source.

↳ minimum_schedule_interval Google\Protobuf\Duration

The minimum interval for scheduler to schedule runs.

getName

Output only. Data source resource name.

Returns
TypeDescription
string

setName

Output only. Data source resource name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataSourceId

Data source id.

Returns
TypeDescription
string

setDataSourceId

Data source id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

User friendly data source name.

Returns
TypeDescription
string

setDisplayName

User friendly data source name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

User friendly data source description string.

Returns
TypeDescription
string

setDescription

User friendly data source description string.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientId

Data source client id which should be used to receive refresh token.

Returns
TypeDescription
string

setClientId

Data source client id which should be used to receive refresh token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScopes

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setScopes

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getTransferType

Deprecated. This field has no effect.

Returns
TypeDescription
int

setTransferType

Deprecated. This field has no effect.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSupportsMultipleTransfers

Deprecated. This field has no effect.

Returns
TypeDescription
bool

setSupportsMultipleTransfers

Deprecated. This field has no effect.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUpdateDeadlineSeconds

The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

Returns
TypeDescription
int

setUpdateDeadlineSeconds

The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultSchedule

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.

Returns
TypeDescription
string

setDefaultSchedule

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSupportsCustomSchedule

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.

Returns
TypeDescription
bool

setSupportsCustomSchedule

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getParameters

Data source parameters.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParameters

Data source parameters.

Parameter
NameDescription
var array<Google\Cloud\BigQuery\DataTransfer\V1\DataSourceParameter>
Returns
TypeDescription
$this

getHelpUrl

Url for the help document for this data source.

Returns
TypeDescription
string

setHelpUrl

Url for the help document for this data source.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAuthorizationType

Indicates the type of authorization.

Returns
TypeDescription
int

setAuthorizationType

Indicates the type of authorization.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDataRefreshType

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.

Returns
TypeDescription
int

setDataRefreshType

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultDataRefreshWindowDays

Default data refresh window on days.

Only meaningful when data_refresh_type = SLIDING_WINDOW.

Returns
TypeDescription
int

setDefaultDataRefreshWindowDays

Default data refresh window on days.

Only meaningful when data_refresh_type = SLIDING_WINDOW.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getManualRunsDisabled

Disables backfilling and manual run scheduling for the data source.

Returns
TypeDescription
bool

setManualRunsDisabled

Disables backfilling and manual run scheduling for the data source.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getMinimumScheduleInterval

The minimum interval for scheduler to schedule runs.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasMinimumScheduleInterval

clearMinimumScheduleInterval

setMinimumScheduleInterval

The minimum interval for scheduler to schedule runs.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this