Class: Google::Apis::BigquerydatatransferV1::DataSource
- Inherits:
-
Object
- Object
- Google::Apis::BigquerydatatransferV1::DataSource
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/bigquerydatatransfer_v1/classes.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb
Overview
Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
Instance Attribute Summary collapse
-
#authorization_type ⇒ String
Indicates the type of authorization.
-
#client_id ⇒ String
Data source client id which should be used to receive refresh token.
-
#data_refresh_type ⇒ String
Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
-
#data_source_id ⇒ String
Data source id.
-
#default_data_refresh_window_days ⇒ Fixnum
Default data refresh window on days.
-
#default_schedule ⇒ String
Default data transfer schedule.
-
#description ⇒ String
User friendly data source description string.
-
#display_name ⇒ String
User friendly data source name.
-
#help_url ⇒ String
Url for the help document for this data source.
-
#manual_runs_disabled ⇒ Boolean
(also: #manual_runs_disabled?)
Disables backfilling and manual run scheduling for the data source.
-
#minimum_schedule_interval ⇒ String
The minimum interval for scheduler to schedule runs.
-
#name ⇒ String
Output only.
-
#parameters ⇒ Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>
Data source parameters.
-
#scopes ⇒ Array<String>
Api auth scopes for which refresh token needs to be obtained.
-
#supports_custom_schedule ⇒ Boolean
(also: #supports_custom_schedule?)
Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
-
#supports_multiple_transfers ⇒ Boolean
(also: #supports_multiple_transfers?)
Indicates whether the data source supports multiple transfers to different BigQuery targets.
-
#transfer_type ⇒ String
Deprecated.
-
#update_deadline_seconds ⇒ Fixnum
The number of seconds to wait for an update from the data source before BigQuery marks the transfer as failed.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DataSource
constructor
A new instance of DataSource.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DataSource
Returns a new instance of DataSource
178 179 180 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 178 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authorization_type ⇒ String
Indicates the type of authorization.
Corresponds to the JSON property authorizationType
71 72 73 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 71 def @authorization_type end |
#client_id ⇒ String
Data source client id which should be used to receive refresh token.
When not supplied, no offline credentials are populated for data transfer.
Corresponds to the JSON property clientId
77 78 79 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 77 def client_id @client_id end |
#data_refresh_type ⇒ String
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.
Corresponds to the JSON property dataRefreshType
85 86 87 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 85 def data_refresh_type @data_refresh_type end |
#data_source_id ⇒ String
Data source id.
Corresponds to the JSON property dataSourceId
90 91 92 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 90 def data_source_id @data_source_id end |
#default_data_refresh_window_days ⇒ Fixnum
Default data refresh window on days.
Only meaningful when data_refresh_type
= SLIDING_WINDOW
.
Corresponds to the JSON property defaultDataRefreshWindowDays
96 97 98 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 96 def default_data_refresh_window_days @default_data_refresh_window_days end |
#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
.
Corresponds to the JSON property defaultSchedule
105 106 107 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 105 def default_schedule @default_schedule end |
#description ⇒ String
User friendly data source description string.
Corresponds to the JSON property description
110 111 112 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 110 def description @description end |
#display_name ⇒ String
User friendly data source name.
Corresponds to the JSON property displayName
115 116 117 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 115 def display_name @display_name end |
#help_url ⇒ String
Url for the help document for this data source.
Corresponds to the JSON property helpUrl
120 121 122 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 120 def help_url @help_url end |
#manual_runs_disabled ⇒ Boolean Also known as: manual_runs_disabled?
Disables backfilling and manual run scheduling
for the data source.
Corresponds to the JSON property manualRunsDisabled
126 127 128 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 126 def manual_runs_disabled @manual_runs_disabled end |
#minimum_schedule_interval ⇒ String
The minimum interval for scheduler to schedule runs.
Corresponds to the JSON property minimumScheduleInterval
132 133 134 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 132 def minimum_schedule_interval @minimum_schedule_interval end |
#name ⇒ String
Output only. Data source resource name.
Corresponds to the JSON property name
137 138 139 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 137 def name @name end |
#parameters ⇒ Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>
Data source parameters.
Corresponds to the JSON property parameters
142 143 144 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 142 def parameters @parameters end |
#scopes ⇒ Array<String>
Api auth scopes for which refresh token needs to be obtained. Only valid
when client_id
is specified. Ignored otherwise. These are scopes needed
by a data source to prepare data and ingest them into BigQuery,
e.g., https://www.googleapis.com/auth/bigquery
Corresponds to the JSON property scopes
150 151 152 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 150 def scopes @scopes end |
#supports_custom_schedule ⇒ Boolean Also known as: supports_custom_schedule?
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.
Corresponds to the JSON property supportsCustomSchedule
157 158 159 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 157 def supports_custom_schedule @supports_custom_schedule end |
#supports_multiple_transfers ⇒ Boolean Also known as: supports_multiple_transfers?
Indicates whether the data source supports multiple transfers
to different BigQuery targets.
Corresponds to the JSON property supportsMultipleTransfers
164 165 166 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 164 def supports_multiple_transfers @supports_multiple_transfers end |
#transfer_type ⇒ String
Deprecated. This field has no effect.
Corresponds to the JSON property transferType
170 171 172 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 170 def transfer_type @transfer_type end |
#update_deadline_seconds ⇒ Fixnum
The number of seconds to wait for an update from the data source
before BigQuery marks the transfer as failed.
Corresponds to the JSON property updateDeadlineSeconds
176 177 178 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 176 def update_deadline_seconds @update_deadline_seconds end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 183 def update!(**args) @authorization_type = args[:authorization_type] if args.key?(:authorization_type) @client_id = args[:client_id] if args.key?(:client_id) @data_refresh_type = args[:data_refresh_type] if args.key?(:data_refresh_type) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) @default_data_refresh_window_days = args[:default_data_refresh_window_days] if args.key?(:default_data_refresh_window_days) @default_schedule = args[:default_schedule] if args.key?(:default_schedule) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @help_url = args[:help_url] if args.key?(:help_url) @manual_runs_disabled = args[:manual_runs_disabled] if args.key?(:manual_runs_disabled) @minimum_schedule_interval = args[:minimum_schedule_interval] if args.key?(:minimum_schedule_interval) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) @scopes = args[:scopes] if args.key?(:scopes) @supports_custom_schedule = args[:supports_custom_schedule] if args.key?(:supports_custom_schedule) @supports_multiple_transfers = args[:supports_multiple_transfers] if args.key?(:supports_multiple_transfers) @transfer_type = args[:transfer_type] if args.key?(:transfer_type) @update_deadline_seconds = args[:update_deadline_seconds] if args.key?(:update_deadline_seconds) end |