public final class DateTime extends GeneratedMessageV3 implements DateTimeOrBuilderRepresents 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.
Protobuf type google.type.DateTime
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DateTimeImplements
DateTimeOrBuilderStatic Fields
DAY_FIELD_NUMBER
public static final int DAY_FIELD_NUMBER| Type | Description |
int |
HOURS_FIELD_NUMBER
public static final int HOURS_FIELD_NUMBER| Type | Description |
int |
MINUTES_FIELD_NUMBER
public static final int MINUTES_FIELD_NUMBER| Type | Description |
int |
MONTH_FIELD_NUMBER
public static final int MONTH_FIELD_NUMBER| Type | Description |
int |
NANOS_FIELD_NUMBER
public static final int NANOS_FIELD_NUMBER| Type | Description |
int |
SECONDS_FIELD_NUMBER
public static final int SECONDS_FIELD_NUMBER| Type | Description |
int |
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER| Type | Description |
int |
UTC_OFFSET_FIELD_NUMBER
public static final int UTC_OFFSET_FIELD_NUMBER| Type | Description |
int |
YEAR_FIELD_NUMBER
public static final int YEAR_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static DateTime getDefaultInstance()| Type | Description |
DateTime |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static DateTime.Builder newBuilder()| Type | Description |
DateTime.Builder |
newBuilder(DateTime prototype)
public static DateTime.Builder newBuilder(DateTime prototype)| Name | Description |
prototype | DateTime |
| Type | Description |
DateTime.Builder |
parseDelimitedFrom(InputStream input)
public static DateTime parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DateTime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static DateTime parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static DateTime parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static DateTime parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static DateTime parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static DateTime parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DateTime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
DateTime |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<DateTime> parser()| Type | Description |
Parser<DateTime> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getDay()
public int getDay()Required. Day of month. Must be from 1 to 31 and valid for the year and month.
int32 day = 3;
| Type | Description |
int | The day. |
getDefaultInstanceForType()
public DateTime getDefaultInstanceForType()| Type | Description |
DateTime |
getHours()
public int 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;
| Type | Description |
int | The hours. |
getMinutes()
public int getMinutes()Required. Minutes of hour of day. Must be from 0 to 59.
int32 minutes = 5;
| Type | Description |
int | The minutes. |
getMonth()
public int getMonth()Required. Month of year. Must be from 1 to 12.
int32 month = 2;
| Type | Description |
int | The month. |
getNanos()
public int getNanos()Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
int32 nanos = 7;
| Type | Description |
int | The nanos. |
getParserForType()
public Parser<DateTime> getParserForType()| Type | Description |
Parser<DateTime> |
getSeconds()
public int 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;
| Type | Description |
int | The seconds. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
getTimeOffsetCase()
public DateTime.TimeOffsetCase getTimeOffsetCase()| Type | Description |
DateTime.TimeOffsetCase |
getTimeZone()
public TimeZone getTimeZone()Time zone.
.google.type.TimeZone time_zone = 9;
| Type | Description |
TimeZone | The timeZone. |
getTimeZoneOrBuilder()
public TimeZoneOrBuilder getTimeZoneOrBuilder()Time zone.
.google.type.TimeZone time_zone = 9;
| Type | Description |
TimeZoneOrBuilder |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
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;
| 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;
| Type | Description |
DurationOrBuilder |
getYear()
public int getYear()Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
int32 year = 1;
| Type | Description |
int | The year. |
hasTimeZone()
public boolean hasTimeZone()Time zone.
.google.type.TimeZone time_zone = 9;
| 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;
| Type | Description |
boolean | Whether the utcOffset field is set. |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public DateTime.Builder newBuilderForType()| Type | Description |
DateTime.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DateTime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
DateTime.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public DateTime.Builder toBuilder()| Type | Description |
DateTime.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |