Class DateTime (2.24.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DateTime

Implements

DateTimeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
`DateTime`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static DateTime.Builder newBuilder()

Returns
Type	Description
`DateTime.Builder`

newBuilder(DateTime prototype)

public static DateTime.Builder newBuilder(DateTime prototype)

Parameter
Name	Description
`prototype`	`DateTime`

Returns
Type	Description
`DateTime.Builder`

parseDelimitedFrom(InputStream input)

public static DateTime parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static DateTime parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static DateTime parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static DateTime parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static DateTime parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static DateTime parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DateTime`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<DateTime> parser()

Returns
Type	Description
`Parser<DateTime>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDay()

public int 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()

Returns
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;

Returns
Type	Description
`int`	The hours.

getMinutes()

public int getMinutes()

Required. Minutes of hour of day. Must be from 0 to 59.

int32 minutes = 5;

Returns
Type	Description
`int`	The minutes.

getMonth()

public int getMonth()

Required. Month of year. Must be from 1 to 12.

int32 month = 2;

Returns
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;

Returns
Type	Description
`int`	The nanos.

getParserForType()

public Parser<DateTime> getParserForType()

Returns
Type	Description
`Parser<DateTime>`

Overrides

GeneratedMessageV3.getParserForType()

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;

Returns
Type	Description
`int`	The seconds.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTimeOffsetCase()

public DateTime.TimeOffsetCase getTimeOffsetCase()

Returns
Type	Description
`DateTime.TimeOffsetCase`

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;

Returns
Type	Description
`TimeZoneOrBuilder`

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;

Returns
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;

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()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DateTime.Builder newBuilderForType()

Returns
Type	Description
`DateTime.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DateTime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DateTime.Builder toBuilder()

Returns
Type	Description
`DateTime.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`