Class: Google::Apis::MybusinessV3::SpecialHourPeriod
- Inherits:
-
Object
- Object
- Google::Apis::MybusinessV3::SpecialHourPeriod
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/mybusiness_v3/classes.rb,
generated/google/apis/mybusiness_v3/representations.rb,
generated/google/apis/mybusiness_v3/representations.rb
Overview
Represents a single time period when a location's operational hours differ
from its normal business hours.
A special hour period must represent a range of less than 24 hours.
The open_time
and start_date
must predate the close_time
and end_date
.
The close_time
and end_date
can extend to 11:59 a.m. on the day after
the specified start_date
.
For example, the following inputs are valid:
start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:
00
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:
59
The following inputs are NOT valid:
start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:
00
start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:
00
Instance Attribute Summary collapse
-
#close_time ⇒ String
The wall time on end_date when a location closes, expressed in 24hr ISO 8601 extended format.
-
#end_date ⇒ Google::Apis::MybusinessV3::Date
Represents a whole calendar date, e.g.
-
#is_closed ⇒ Boolean
(also: #is_closed?)
If true, end_date, open_time, and close_time are ignored, and the date specified in start_date is treated as the location being closed for the entire day.
-
#open_time ⇒ String
The wall time on
start_date
when a location opens, expressed in 24hr ISO 8601 extended format. -
#start_date ⇒ Google::Apis::MybusinessV3::Date
Represents a whole calendar date, e.g.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SpecialHourPeriod
constructor
A new instance of SpecialHourPeriod.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SpecialHourPeriod
Returns a new instance of SpecialHourPeriod
1762 1763 1764 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1762 def initialize(**args) update!(**args) end |
Instance Attribute Details
#close_time ⇒ String
The wall time on end_date when a location closes, expressed in
24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00,
where 24:00 represents midnight at the end of the specified day field.
Must be specified if is_closed is false.
Corresponds to the JSON property closeTime
1722 1723 1724 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1722 def close_time @close_time end |
#end_date ⇒ Google::Apis::MybusinessV3::Date
Represents a whole calendar date, e.g. date of birth. The time of day and
time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. The day may be 0 to
represent a year and month where the day is not significant, e.g. credit card
expiration date. The year may be 0 to represent a month and day independent
of year, e.g. anniversary date. Related types are google.type.TimeOfDay
and google.protobuf.Timestamp
.
Corresponds to the JSON property endDate
1733 1734 1735 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1733 def end_date @end_date end |
#is_closed ⇒ Boolean Also known as: is_closed?
If true, end_date, open_time, and close_time are ignored,
and the date specified in start_date is treated as the location being
closed for the entire day.
Corresponds to the JSON property isClosed
1740 1741 1742 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1740 def is_closed @is_closed end |
#open_time ⇒ String
The wall time on start_date
when a location opens, expressed in
24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00,
where 24:00 represents midnight at the end of the specified day field.
Must be specified if is_closed
is false.
Corresponds to the JSON property openTime
1749 1750 1751 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1749 def open_time @open_time end |
#start_date ⇒ Google::Apis::MybusinessV3::Date
Represents a whole calendar date, e.g. date of birth. The time of day and
time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. The day may be 0 to
represent a year and month where the day is not significant, e.g. credit card
expiration date. The year may be 0 to represent a month and day independent
of year, e.g. anniversary date. Related types are google.type.TimeOfDay
and google.protobuf.Timestamp
.
Corresponds to the JSON property startDate
1760 1761 1762 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1760 def start_date @start_date end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1767 1768 1769 1770 1771 1772 1773 |
# File 'generated/google/apis/mybusiness_v3/classes.rb', line 1767 def update!(**args) @close_time = args[:close_time] if args.key?(:close_time) @end_date = args[:end_date] if args.key?(:end_date) @is_closed = args[:is_closed] if args.key?(:is_closed) @open_time = args[:open_time] if args.key?(:open_time) @start_date = args[:start_date] if args.key?(:start_date) end |