public final class DateTime extends GeneratedMessageV3 implements DateTimeOrBuilder
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.
Protobuf type google.type.DateTime
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DAY_FIELD_NUMBER
public static final int DAY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HOURS_FIELD_NUMBER
public static final int HOURS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MINUTES_FIELD_NUMBER
public static final int MINUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MONTH_FIELD_NUMBER
public static final int MONTH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NANOS_FIELD_NUMBER
public static final int NANOS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SECONDS_FIELD_NUMBER
public static final int SECONDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UTC_OFFSET_FIELD_NUMBER
public static final int UTC_OFFSET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
YEAR_FIELD_NUMBER
public static final int YEAR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DateTime getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DateTime.Builder newBuilder()
newBuilder(DateTime prototype)
public static DateTime.Builder newBuilder(DateTime prototype)
| Parameter |
| Name |
Description |
prototype |
DateTime
|
public static DateTime parseDelimitedFrom(InputStream input)
public static DateTime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DateTime parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DateTime parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(CodedInputStream input)
public static DateTime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(InputStream input)
public static DateTime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DateTime parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DateTime> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDay()
Required. Day of month. Must be from 1 to 31 and valid for the year and
month.
int32 day = 3;
| Returns |
| Type |
Description |
int |
The day.
|
getDefaultInstanceForType()
public DateTime getDefaultInstanceForType()
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.
int32 hours = 4;
| Returns |
| Type |
Description |
int |
The hours.
|
getMinutes()
Required. Minutes of hour of day. Must be from 0 to 59.
int32 minutes = 5;
| Returns |
| Type |
Description |
int |
The minutes.
|
getMonth()
Required. Month of year. Must be from 1 to 12.
int32 month = 2;
| Returns |
| Type |
Description |
int |
The month.
|
getNanos()
Required. Fractions of seconds in nanoseconds. Must be from 0 to
999,999,999.
int32 nanos = 7;
| Returns |
| Type |
Description |
int |
The nanos.
|
getParserForType()
public Parser<DateTime> getParserForType()
Overrides
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.
int32 seconds = 6;
| Returns |
| Type |
Description |
int |
The seconds.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTimeOffsetCase()
public DateTime.TimeOffsetCase getTimeOffsetCase()
getTimeZone()
public TimeZone getTimeZone()
Time zone.
.google.type.TimeZone time_zone = 9;
| Returns |
| Type |
Description |
TimeZone |
The timeZone.
|
getTimeZoneOrBuilder()
public TimeZoneOrBuilder getTimeZoneOrBuilder()
Time zone.
.google.type.TimeZone time_zone = 9;
getUtcOffset()
public Duration 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 }.
.google.protobuf.Duration utc_offset = 8;
| Returns |
| Type |
Description |
Duration |
The utcOffset.
|
getUtcOffsetOrBuilder()
public DurationOrBuilder getUtcOffsetOrBuilder()
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 }.
.google.protobuf.Duration utc_offset = 8;
getYear()
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
datetime without a year.
int32 year = 1;
| Returns |
| Type |
Description |
int |
The year.
|
hasTimeZone()
public boolean hasTimeZone()
Time zone.
.google.type.TimeZone time_zone = 9;
| Returns |
| Type |
Description |
boolean |
Whether the timeZone field is set.
|
hasUtcOffset()
public boolean hasUtcOffset()
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 }.
.google.protobuf.Duration utc_offset = 8;
| Returns |
| Type |
Description |
boolean |
Whether the utcOffset field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DateTime.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DateTime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DateTime.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
