Reference documentation and code samples for the Google API Common Protos Client class 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_offsetoneof is set. Consider usingTimestampmessage 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.
Generated from protobuf message google.type.DateTime
Namespace
Google \ TypeMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ year
int
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
↳ month
int
Required. Month of year. Must be from 1 to 12.
↳ day
int
Required. Day of month. Must be from 1 to 31 and valid for the year and month.
↳ hours
int
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
int
Required. Minutes of hour of day. Must be from 0 to 59.
↳ seconds
int
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.
↳ nanos
int
Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
↳ utc_offset
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 }.
↳ time_zone
getYear
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
int
setYear
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
var
int
$this
getMonth
Required. Month of year. Must be from 1 to 12.
int
setMonth
Required. Month of year. Must be from 1 to 12.
var
int
$this
getDay
Required. Day of month. Must be from 1 to 31 and valid for the year and month.
int
setDay
Required. Day of month. Must be from 1 to 31 and valid for the year and month.
var
int
$this
getHours
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.
int
setHours
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.
var
int
$this
getMinutes
Required. Minutes of hour of day. Must be from 0 to 59.
int
setMinutes
Required. Minutes of hour of day. Must be from 0 to 59.
var
int
$this
getSeconds
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.
int
setSeconds
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.
var
int
$this
getNanos
Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
int
setNanos
Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
var
int
$this
getUtcOffset
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 }.
hasUtcOffset
setUtcOffset
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 }.
$this
getTimeZone
Time zone.
hasTimeZone
setTimeZone
Time zone.
$this
getTimeOffset
string
