Class: Google::Apis::ContentV2::DatafeedFetchSchedule
- Inherits:
-
Object
- Object
- Google::Apis::ContentV2::DatafeedFetchSchedule
- Defined in:
- generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/google/apis/content_v2/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
-
#day_of_month ⇒ Fixnum
The day of the month the feed file should be fetched (1-31).
-
#fetch_url ⇒ String
The URL where the feed file can be fetched.
-
#hour ⇒ Fixnum
The hour of the day the feed file should be fetched (0-23).
-
#minute_of_hour ⇒ Fixnum
The minute of the hour the feed file should be fetched (0-59).
-
#password ⇒ String
An optional password for fetch_url.
-
#paused ⇒ Boolean
(also: #paused?)
Whether the scheduled fetch is paused or not.
-
#time_zone ⇒ String
Time zone used for schedule.
-
#username ⇒ String
An optional user name for fetch_url.
-
#weekday ⇒ String
The day of the week the feed file should be fetched.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DatafeedFetchSchedule
constructor
A new instance of DatafeedFetchSchedule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ DatafeedFetchSchedule
Returns a new instance of DatafeedFetchSchedule
1485 1486 1487 |
# File 'generated/google/apis/content_v2/classes.rb', line 1485 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
1439 1440 1441 |
# File 'generated/google/apis/content_v2/classes.rb', line 1439 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
1447 1448 1449 |
# File 'generated/google/apis/content_v2/classes.rb', line 1447 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
1452 1453 1454 |
# File 'generated/google/apis/content_v2/classes.rb', line 1452 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
1457 1458 1459 |
# File 'generated/google/apis/content_v2/classes.rb', line 1457 def minute_of_hour @minute_of_hour end |
#password ⇒ String
An optional password for fetch_url.
Corresponds to the JSON property password
1462 1463 1464 |
# File 'generated/google/apis/content_v2/classes.rb', line 1462 def password @password end |
#paused ⇒ Boolean Also known as: paused?
Whether the scheduled fetch is paused or not.
Corresponds to the JSON property paused
1467 1468 1469 |
# File 'generated/google/apis/content_v2/classes.rb', line 1467 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
1473 1474 1475 |
# File 'generated/google/apis/content_v2/classes.rb', line 1473 def time_zone @time_zone end |
#username ⇒ String
An optional user name for fetch_url.
Corresponds to the JSON property username
1478 1479 1480 |
# File 'generated/google/apis/content_v2/classes.rb', line 1478 def username @username end |
#weekday ⇒ String
The day of the week the feed file should be fetched.
Corresponds to the JSON property weekday
1483 1484 1485 |
# File 'generated/google/apis/content_v2/classes.rb', line 1483 def weekday @weekday end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 |
# File 'generated/google/apis/content_v2/classes.rb', line 1490 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 |