Class: Google::Apis::DocumentaiV1::GoogleTypeDateTime
- Inherits:
-
Object
- Object
- Google::Apis::DocumentaiV1::GoogleTypeDateTime
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb
Overview
Represents civil time (or occasionally physical time). This type can represent
a 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 may also be used to represent a physical time if all
the date and time fields are set and either case of the time_offset
oneof is
set. Consider using Timestamp
message for physical time instead. If your use
case also would like to store the user's timezone, that can be done in another
field. 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 ⇒ Fixnum
Required.
-
#hours ⇒ Fixnum
Required.
-
#minutes ⇒ Fixnum
Required.
-
#month ⇒ Fixnum
Required.
-
#nanos ⇒ Fixnum
Required.
-
#seconds ⇒ Fixnum
Required.
-
#time_zone ⇒ Google::Apis::DocumentaiV1::GoogleTypeTimeZone
Represents a time zone from the IANA Time Zone Database.
-
#utc_offset ⇒ String
UTC offset.
-
#year ⇒ Fixnum
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleTypeDateTime
constructor
A new instance of GoogleTypeDateTime.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleTypeDateTime
Returns a new instance of GoogleTypeDateTime.
8105 8106 8107 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8105 def initialize(**args) update!(**args) end |
Instance Attribute Details
#day ⇒ Fixnum
Required. Day of month. Must be from 1 to 31 and valid for the year and month.
Corresponds to the JSON property day
8058 8059 8060 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8058 def day @day end |
#hours ⇒ Fixnum
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.
Corresponds to the JSON property hours
8064 8065 8066 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8064 def hours @hours end |
#minutes ⇒ Fixnum
Required. Minutes of hour of day. Must be from 0 to 59.
Corresponds to the JSON property minutes
8069 8070 8071 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8069 def minutes @minutes end |
#month ⇒ Fixnum
Required. Month of year. Must be from 1 to 12.
Corresponds to the JSON property month
8074 8075 8076 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8074 def month @month end |
#nanos ⇒ Fixnum
Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Corresponds to the JSON property nanos
8079 8080 8081 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8079 def nanos @nanos end |
#seconds ⇒ Fixnum
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.
Corresponds to the JSON property seconds
8085 8086 8087 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8085 def seconds @seconds end |
#time_zone ⇒ Google::Apis::DocumentaiV1::GoogleTypeTimeZone
Represents a time zone from the IANA Time Zone Database.
Corresponds to the JSON property timeZone
8091 8092 8093 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8091 def time_zone @time_zone end |
#utc_offset ⇒ String
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
.
Corresponds to the JSON property utcOffset
8097 8098 8099 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8097 def utc_offset @utc_offset end |
#year ⇒ Fixnum
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime
without a year.
Corresponds to the JSON property year
8103 8104 8105 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8103 def year @year end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8110 def update!(**args) @day = args[:day] if args.key?(:day) @hours = args[:hours] if args.key?(:hours) @minutes = args[:minutes] if args.key?(:minutes) @month = args[:month] if args.key?(:month) @nanos = args[:nanos] if args.key?(:nanos) @seconds = args[:seconds] if args.key?(:seconds) @time_zone = args[:time_zone] if args.key?(:time_zone) @utc_offset = args[:utc_offset] if args.key?(:utc_offset) @year = args[:year] if args.key?(:year) end |