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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DatafeedFetchSchedule

Returns a new instance of DatafeedFetchSchedule



1696
1697
1698
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1696

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) 


1650
1651
1652
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1650

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) 


1658
1659
1660
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1658

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) 


1663
1664
1665
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1663

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) 


1668
1669
1670
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1668

def minute_of_hour
  @minute_of_hour
end

#password ⇒ String

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

Returns:

  • (String) 


1673
1674
1675
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1673

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) 


1678
1679
1680
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1678

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) 


1684
1685
1686
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1684

def time_zone
  @time_zone
end

#username ⇒ String

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

Returns:

  • (String) 


1689
1690
1691
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1689

def username
  @username
end

#weekday ⇒ String

The day of the week the feed file should be fetched. Corresponds to the JSON property weekday

Returns:

  • (String) 


1694
1695
1696
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1694

def weekday
  @weekday
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1701

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