Class: Google::Apis::MerchantapiDatasourcesV1beta::FetchSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/merchantapi_datasources_v1beta/classes.rb,
lib/google/apis/merchantapi_datasources_v1beta/representations.rb,
lib/google/apis/merchantapi_datasources_v1beta/representations.rb

Overview

Fetch details to deliver the data source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FetchSettings

Returns a new instance of FetchSettings.



192
193
194
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 192

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#day_of_month ⇒ Fixnum

Optional. The day of the month when the data source file should be fetched (1- 31). This field can only be set for monthly frequency. Corresponds to the JSON property dayOfMonth

Returns:

  • (Fixnum) 


140
141
142
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 140

def day_of_month
  @day_of_month
end

#day_of_week ⇒ String

Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. Corresponds to the JSON property dayOfWeek

Returns:

  • (String) 


146
147
148
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 146

def day_of_week
  @day_of_week
end

#enabled ⇒ Boolean Also known as: enabled?

Optional. Enables or pauses the fetch schedule. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 151

def enabled
  @enabled
end

#fetch_uri ⇒ String

Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files. Corresponds to the JSON property fetchUri

Returns:

  • (String) 


160
161
162
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 160

def fetch_uri
  @fetch_uri
end

#frequency ⇒ String

Required. The frequency describing fetch schedule. Corresponds to the JSON property frequency

Returns:

  • (String) 


165
166
167
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 165

def frequency
  @frequency
end

#password ⇒ String

Optional. An optional password for fetch url. Used for submitting data sources through SFTP. Corresponds to the JSON property password

Returns:

  • (String) 


171
172
173
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 171

def password
  @password
end

#time_of_day ⇒ Google::Apis::MerchantapiDatasourcesV1beta::TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. Corresponds to the JSON property timeOfDay

Returns:



178
179
180
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 178

def time_of_day
  @time_of_day
end

#time_zone ⇒ String

Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles". Corresponds to the JSON property timeZone

Returns:

  • (String) 


184
185
186
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 184

def time_zone
  @time_zone
end

#username ⇒ String

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP. Corresponds to the JSON property username

Returns:

  • (String) 


190
191
192
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 190

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/google/apis/merchantapi_datasources_v1beta/classes.rb', line 197

def update!(**args)
  @day_of_month = args[:day_of_month] if args.key?(:day_of_month)
  @day_of_week = args[:day_of_week] if args.key?(:day_of_week)
  @enabled = args[:enabled] if args.key?(:enabled)
  @fetch_uri = args[:fetch_uri] if args.key?(:fetch_uri)
  @frequency = args[:frequency] if args.key?(:frequency)
  @password = args[:password] if args.key?(:password)
  @time_of_day = args[:time_of_day] if args.key?(:time_of_day)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @username = args[:username] if args.key?(:username)
end