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.



3745
3746
3747
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3745

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) 


3696
3697
3698
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3696

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) 


3704
3705
3706
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3704

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) 


3709
3710
3711
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3709

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) 


3714
3715
3716
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3714

def minute_of_hour
  @minute_of_hour
end

#password ⇒ String

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

Returns:

  • (String) 


3719
3720
3721
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3719

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) 


3724
3725
3726
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3724

def paused
  @paused
end

#time_zone ⇒ String

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

Returns:

  • (String) 


3731
3732
3733
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3731

def time_zone
  @time_zone
end

#username ⇒ String

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

Returns:

  • (String) 


3736
3737
3738
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3736

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) 


3743
3744
3745
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3743

def weekday
  @weekday
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3750

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