DataSource

import type { DataSource } from "https://googleapis.deno.dev/v1/bigquerydatatransfer:v1.ts";

Defines the properties and custom parameters for a data source.

interface DataSource {

authorizationType?:

| "AUTHORIZATION_TYPE_UNSPECIFIED"

| "AUTHORIZATION_CODE"

| "GOOGLE_PLUS_AUTHORIZATION_CODE"

| "FIRST_PARTY_OAUTH";

clientId?: string;

dataRefreshType?: "DATA_REFRESH_TYPE_UNSPECIFIED" | "SLIDING_WINDOW" | "CUSTOM_SLIDING_WINDOW";

dataSourceId?: string;

defaultDataRefreshWindowDays?: number;

defaultSchedule?: string;

description?: string;

displayName?: string;

helpUrl?: string;

manualRunsDisabled?: boolean;

minimumScheduleInterval?: number;

readonly name?: string;

parameters?: DataSourceParameter[];

scopes?: string[];

supportsCustomSchedule?: boolean;

supportsMultipleTransfers?: boolean;

transferType?: "TRANSFER_TYPE_UNSPECIFIED" | "BATCH" | "STREAMING";

updateDeadlineSeconds?: number;

}

§Properties

authorizationType?: "AUTHORIZATION_TYPE_UNSPECIFIED" | "AUTHORIZATION_CODE" | "GOOGLE_PLUS_AUTHORIZATION_CODE" | "FIRST_PARTY_OAUTH"

[src]

Indicates the type of authorization.

clientId?: string

[src]

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

dataRefreshType?: "DATA_REFRESH_TYPE_UNSPECIFIED" | "SLIDING_WINDOW" | "CUSTOM_SLIDING_WINDOW"

[src]

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.

dataSourceId?: string

[src]

Data source id.

defaultDataRefreshWindowDays?: number

[src]

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

defaultSchedule?: string

[src]

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.

description?: string

[src]

User friendly data source description string.

displayName?: string

[src]

User friendly data source name.

helpUrl?: string

[src]

Url for the help document for this data source.

manualRunsDisabled?: boolean

[src]

Disables backfilling and manual run scheduling for the data source.

minimumScheduleInterval?: number

[src]

The minimum interval for scheduler to schedule runs.

readonly name?: string

[src]

Output only. Data source resource name.

parameters?: DataSourceParameter[]

[src]

Data source parameters.

scopes?: string[]

[src]

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

supportsCustomSchedule?: boolean

[src]

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.

supportsMultipleTransfers?: boolean

[src]

Deprecated. This field has no effect.

transferType?: "TRANSFER_TYPE_UNSPECIFIED" | "BATCH" | "STREAMING"

[src]

Deprecated. This field has no effect.

updateDeadlineSeconds?: number

[src]

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