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 | |
|---|---|
| Name | Description |
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: |
↳ supports_custom_schedule |
bool
Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to |
↳ 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 |
↳ 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Data source resource name.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataSourceId
Data source id.
Generated from protobuf field string data_source_id = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDataSourceId
Data source id.
Generated from protobuf field string data_source_id = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
User friendly data source name.
Generated from protobuf field string display_name = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User friendly data source name.
Generated from protobuf field string display_name = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
User friendly data source description string.
Generated from protobuf field string description = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
User friendly data source description string.
Generated from protobuf field string description = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClientId
Data source client id which should be used to receive refresh token.
Generated from protobuf field string client_id = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setClientId
Data source client id which should be used to receive refresh token.
Generated from protobuf field string client_id = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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
Generated from protobuf field repeated string scopes = 6;
| Returns | |
|---|---|
| Type | Description |
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
Generated from protobuf field repeated string scopes = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTransferType
Deprecated. This field has no effect.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int | |
setTransferType
Deprecated. This field has no effect.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSupportsMultipleTransfers
Deprecated. This field has no effect.
Generated from protobuf field bool supports_multiple_transfers = 8 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
bool | |
setSupportsMultipleTransfers
Deprecated. This field has no effect.
Generated from protobuf field bool supports_multiple_transfers = 8 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field int32 update_deadline_seconds = 9;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field int32 update_deadline_seconds = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string default_schedule = 10;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string default_schedule = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field bool supports_custom_schedule = 11;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field bool supports_custom_schedule = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
Data source parameters.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParameters
Data source parameters.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BigQuery\DataTransfer\V1\DataSourceParameter>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHelpUrl
Url for the help document for this data source.
Generated from protobuf field string help_url = 13;
| Returns | |
|---|---|
| Type | Description |
string | |
setHelpUrl
Url for the help document for this data source.
Generated from protobuf field string help_url = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthorizationType
Indicates the type of authorization.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;
| Returns | |
|---|---|
| Type | Description |
int | |
setAuthorizationType
Indicates the type of authorization.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultDataRefreshWindowDays
Default data refresh window on days.
Only meaningful when data_refresh_type = SLIDING_WINDOW.
Generated from protobuf field int32 default_data_refresh_window_days = 16;
| Returns | |
|---|---|
| Type | Description |
int | |
setDefaultDataRefreshWindowDays
Default data refresh window on days.
Only meaningful when data_refresh_type = SLIDING_WINDOW.
Generated from protobuf field int32 default_data_refresh_window_days = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManualRunsDisabled
Disables backfilling and manual run scheduling for the data source.
Generated from protobuf field bool manual_runs_disabled = 17;
| Returns | |
|---|---|
| Type | Description |
bool | |
setManualRunsDisabled
Disables backfilling and manual run scheduling for the data source.
Generated from protobuf field bool manual_runs_disabled = 17;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinimumScheduleInterval
The minimum interval for scheduler to schedule runs.
Generated from protobuf field .google.protobuf.Duration minimum_schedule_interval = 18;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasMinimumScheduleInterval
clearMinimumScheduleInterval
setMinimumScheduleInterval
The minimum interval for scheduler to schedule runs.
Generated from protobuf field .google.protobuf.Duration minimum_schedule_interval = 18;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |