Class: Google::Apis::ContentV2_1::DatafeedFetchSchedule

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

Overview

The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatafeedFetchSchedule

Returns a new instance of DatafeedFetchSchedule.



2251
2252
2253
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2251

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

Instance Attribute Details

#day_of_month ⇒ Fixnum

The day of the month the feed file should be fetched (1-31). Corresponds to the JSON property dayOfMonth

Returns:

  • (Fixnum) 


2203
2204
2205
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2203

def day_of_month
  @day_of_month
end

#fetch_url ⇒ String

The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. Corresponds to the JSON property fetchUrl

Returns:

  • (String) 


2211
2212
2213
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2211

def fetch_url
  @fetch_url
end

#hour ⇒ Fixnum

The hour of the day the feed file should be fetched (0-23). Corresponds to the JSON property hour

Returns:

  • (Fixnum) 


2216
2217
2218
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2216

def hour
  @hour
end

#minute_of_hour ⇒ Fixnum

The minute of the hour the feed file should be fetched (0-59). Read-only. Corresponds to the JSON property minuteOfHour

Returns:

  • (Fixnum) 


2221
2222
2223
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2221

def minute_of_hour
  @minute_of_hour
end

#password ⇒ String

An optional password for fetch_url. Corresponds to the JSON property password

Returns:

  • (String) 


2226
2227
2228
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2226

def password
  @password
end

#paused ⇒ Boolean Also known as: paused?

Whether the scheduled fetch is paused or not. Corresponds to the JSON property paused

Returns:

  • (Boolean) 


2231
2232
2233
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2231

def paused
  @paused
end

#time_zone ⇒ String

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

Returns:

  • (String) 


2237
2238
2239
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2237

def time_zone
  @time_zone
end

#username ⇒ String

An optional user name for fetch_url. Corresponds to the JSON property username

Returns:

  • (String) 


2242
2243
2244
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2242

def username
  @username
end

#weekday ⇒ String

The day of the week the feed file should be fetched. Acceptable values are: - " monday" - "tuesday" - "wednesday" - "thursday" - "friday" - " saturday" - "sunday" Corresponds to the JSON property weekday

Returns:

  • (String) 


2249
2250
2251
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2249

def weekday
  @weekday
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2256

def update!(**args)
  @day_of_month = args[:day_of_month] if args.key?(:day_of_month)
  @fetch_url = args[:fetch_url] if args.key?(:fetch_url)
  @hour = args[:hour] if args.key?(:hour)
  @minute_of_hour = args[:minute_of_hour] if args.key?(:minute_of_hour)
  @password = args[:password] if args.key?(:password)
  @paused = args[:paused] if args.key?(:paused)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @username = args[:username] if args.key?(:username)
  @weekday = args[:weekday] if args.key?(:weekday)
end