Class: Google::Type::DateTime
- Inherits:
-
Object
- Object
- Google::Type::DateTime
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/type/datetime.rb
Overview
Represents civil time in one of a few possible ways:
- When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
- When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
- When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values.
This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
Instance Attribute Summary collapse
-
#day ⇒ ::Integer
Required.
-
#hours ⇒ ::Integer
Required.
-
#minutes ⇒ ::Integer
Required.
-
#month ⇒ ::Integer
Required.
-
#nanos ⇒ ::Integer
Required.
-
#seconds ⇒ ::Integer
Required.
-
#time_zone ⇒ ::Google::Type::TimeZone
Time zone.
-
#utc_offset ⇒ ::Google::Protobuf::Duration
UTC offset.
-
#year ⇒ ::Integer
Optional.
Instance Attribute Details
#day ⇒ ::Integer
Returns Required. Day of month. Must be from 1 to 31 and valid for the year and month.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#hours ⇒ ::Integer
Returns Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#minutes ⇒ ::Integer
Returns Required. Minutes of hour of day. Must be from 0 to 59.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#month ⇒ ::Integer
Returns Required. Month of year. Must be from 1 to 12.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#nanos ⇒ ::Integer
Returns Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#seconds ⇒ ::Integer
Returns Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#time_zone ⇒ ::Google::Type::TimeZone
Returns Time zone.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#utc_offset ⇒ ::Google::Protobuf::Duration
Returns UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
73 74 75 76 |
# File 'proto_docs/google/type/datetime.rb', line 73 class DateTime include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |