Document AI V1 API - Class Google::Type::DateTime (v0.13.0)

Reference documentation and code samples for the Document AI V1 API class Google::Type::DateTime.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#day

def day() -> ::Integer
Returns
  • (::Integer) — Required. Day of month. Must be from 1 to 31 and valid for the year and month.

#day=

def day=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Day of month. Must be from 1 to 31 and valid for the year and month.
Returns
  • (::Integer) — Required. Day of month. Must be from 1 to 31 and valid for the year and month.

#hours

def hours() -> ::Integer
Returns
  • (::Integer) — 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.

#hours=

def hours=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#minutes

def minutes() -> ::Integer
Returns
  • (::Integer) — Required. Minutes of hour of day. Must be from 0 to 59.

#minutes=

def minutes=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Minutes of hour of day. Must be from 0 to 59.
Returns
  • (::Integer) — Required. Minutes of hour of day. Must be from 0 to 59.

#month

def month() -> ::Integer
Returns
  • (::Integer) — Required. Month of year. Must be from 1 to 12.

#month=

def month=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Month of year. Must be from 1 to 12.
Returns
  • (::Integer) — Required. Month of year. Must be from 1 to 12.

#nanos

def nanos() -> ::Integer
Returns
  • (::Integer) — Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

#nanos=

def nanos=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Returns
  • (::Integer) — Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

#seconds

def seconds() -> ::Integer
Returns
  • (::Integer) — 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.

#seconds=

def seconds=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#time_zone

def time_zone() -> ::Google::Type::TimeZone
Returns

#time_zone=

def time_zone=(value) -> ::Google::Type::TimeZone
Parameter
Returns

#utc_offset

def utc_offset() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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 }.

#utc_offset=

def utc_offset=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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 }.
Returns
  • (::Google::Protobuf::Duration) — 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 }.

#year

def year() -> ::Integer
Returns
  • (::Integer) — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

#year=

def year=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
Returns
  • (::Integer) — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.