Class DateTime

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

Implements

DateTimeOrBuilder

Fields

DAY_FIELD_NUMBER

public static final int DAY_FIELD_NUMBER
Field Value
TypeDescription
int

HOURS_FIELD_NUMBER

public static final int HOURS_FIELD_NUMBER
Field Value
TypeDescription
int

MINUTES_FIELD_NUMBER

public static final int MINUTES_FIELD_NUMBER
Field Value
TypeDescription
int

MONTH_FIELD_NUMBER

public static final int MONTH_FIELD_NUMBER
Field Value
TypeDescription
int

NANOS_FIELD_NUMBER

public static final int NANOS_FIELD_NUMBER
Field Value
TypeDescription
int

SECONDS_FIELD_NUMBER

public static final int SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

UTC_OFFSET_FIELD_NUMBER

public static final int UTC_OFFSET_FIELD_NUMBER
Field Value
TypeDescription
int

YEAR_FIELD_NUMBER

public static final int YEAR_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
int

The day.

getDefaultInstance()

public static DateTime getDefaultInstance()
Returns
TypeDescription
DateTime

getDefaultInstanceForType()

public DateTime getDefaultInstanceForType()
Returns
TypeDescription
DateTime

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
TypeDescription
int

The hours.

getMinutes()

public int getMinutes()

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

int32 minutes = 5;

Returns
TypeDescription
int

The minutes.

getMonth()

public int getMonth()

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

int32 month = 2;

Returns
TypeDescription
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
TypeDescription
int

The nanos.

getParserForType()

public Parser<DateTime> getParserForType()
Returns
TypeDescription
Parser<DateTime>
Overrides

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
TypeDescription
int

The seconds.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimeOffsetCase()

public DateTime.TimeOffsetCase getTimeOffsetCase()
Returns
TypeDescription
DateTime.TimeOffsetCase

getTimeZone()

public TimeZone getTimeZone()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
TypeDescription
TimeZone

The timeZone.

getTimeZoneOrBuilder()

public TimeZoneOrBuilder getTimeZoneOrBuilder()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
TypeDescription
TimeZoneOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The year.

hasTimeZone()

public boolean hasTimeZone()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the utcOffset field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static DateTime.Builder newBuilder()
Returns
TypeDescription
DateTime.Builder

newBuilder(DateTime prototype)

public static DateTime.Builder newBuilder(DateTime prototype)
Parameter
NameDescription
prototypeDateTime
Returns
TypeDescription
DateTime.Builder

newBuilderForType()

public DateTime.Builder newBuilderForType()
Returns
TypeDescription
DateTime.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DateTime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DateTime.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static DateTime parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DateTime parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DateTime parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DateTime parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DateTime parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DateTime parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DateTime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DateTime> parser()
Returns
TypeDescription
Parser<DateTime>

toBuilder()

public DateTime.Builder toBuilder()
Returns
TypeDescription
DateTime.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException