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.



2445
2446
2447
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2445

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) 


2397
2398
2399
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2397

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) 


2405
2406
2407
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2405

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) 


2410
2411
2412
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2410

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) 


2415
2416
2417
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2415

def minute_of_hour
  @minute_of_hour
end

#password ⇒ String

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

Returns:

  • (String) 


2420
2421
2422
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2420

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) 


2425
2426
2427
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2425

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) 


2431
2432
2433
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2431

def time_zone
  @time_zone
end

#username ⇒ String

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

Returns:

  • (String) 


2436
2437
2438
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2436

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) 


2443
2444
2445
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2443

def weekday
  @weekday
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2450

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