google_api_big_query_data_transfer v0.5.0 GoogleApi.BigQueryDataTransfer.V1.Model.DataSource View Source

Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

Attributes

  • parameters ([DataSourceParameter]): Data source parameters. Defaults to: null.
  • authorizationType (String.t): Indicates the type of authorization. Defaults to: null.

    • Enum - one of [AUTHORIZATION_TYPE_UNSPECIFIED, AUTHORIZATION_CODE, GOOGLE_PLUS_AUTHORIZATION_CODE]
  • clientId (String.t): Data source client id which should be used to receive refresh token. Defaults to: null.
  • dataRefreshType (String.t): 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. Defaults to: null.

    • Enum - one of [DATA_REFRESH_TYPE_UNSPECIFIED, SLIDING_WINDOW, CUSTOM_SLIDING_WINDOW]
  • dataSourceId (String.t): Data source id. Defaults to: null.
  • defaultDataRefreshWindowDays (integer()): Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. Defaults to: null.
  • defaultSchedule (String.t): 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`. Defaults to: null.
  • description (String.t): User friendly data source description string. Defaults to: null.
  • displayName (String.t): User friendly data source name. Defaults to: null.
  • helpUrl (String.t): Url for the help document for this data source. Defaults to: null.
  • manualRunsDisabled (boolean()): Disables backfilling and manual run scheduling for the data source. Defaults to: null.
  • minimumScheduleInterval (String.t): The minimum interval for scheduler to schedule runs. Defaults to: null.
  • name (String.t): Output only. Data source resource name. Defaults to: null.
  • scopes ([String.t]): 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 Defaults to: null.
  • supportsCustomSchedule (boolean()): 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. Defaults to: null.
  • supportsMultipleTransfers (boolean()): Deprecated. This field has no effect. Defaults to: null.
  • transferType (String.t): Deprecated. This field has no effect. Defaults to: null.

    • Enum - one of [TRANSFER_TYPE_UNSPECIFIED, BATCH, STREAMING]
  • updateDeadlineSeconds (integer()): The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.BigQueryDataTransfer.V1.Model.DataSource{
  authorizationType: any(),
  clientId: any(),
  dataRefreshType: any(),
  dataSourceId: any(),
  defaultDataRefreshWindowDays: any(),
  defaultSchedule: any(),
  description: any(),
  displayName: any(),
  helpUrl: any(),
  manualRunsDisabled: any(),
  minimumScheduleInterval: any(),
  name: any(),
  parameters: [GoogleApi.BigQueryDataTransfer.V1.Model.DataSourceParameter.t()],
  scopes: [any()],
  supportsCustomSchedule: any(),
  supportsMultipleTransfers: any(),
  transferType: any(),
  updateDeadlineSeconds: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.