Class DateTime

  • All Implemented Interfaces:
    com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DateTimeOrBuilder, java.io.Serializable

    public final class DateTime
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DateTime.Builder
      Represents civil time (or occasionally physical time).
      static class  DateTime.TimeOffsetCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int getDay()
      Required.
      static DateTime getDefaultInstance()  
      DateTime getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      int getHours()
      Required.
      int getMinutes()
      Required.
      int getMonth()
      Required.
      int getNanos()
      Required.
      com.google.protobuf.Parser<DateTime> getParserForType()  
      int getSeconds()
      Required.
      int getSerializedSize()  
      DateTime.TimeOffsetCase getTimeOffsetCase()  
      TimeZone getTimeZone()
      Time zone.
      TimeZoneOrBuilder getTimeZoneOrBuilder()
      Time zone.
      com.google.protobuf.Duration getUtcOffset()
      UTC offset.
      com.google.protobuf.DurationOrBuilder getUtcOffsetOrBuilder()
      UTC offset.
      int getYear()
      Optional.
      int hashCode()  
      boolean hasTimeZone()
      Time zone.
      boolean hasUtcOffset()
      UTC offset.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static DateTime.Builder newBuilder()  
      static DateTime.Builder newBuilder​(DateTime prototype)  
      DateTime.Builder newBuilderForType()  
      protected DateTime.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static DateTime parseDelimitedFrom​(java.io.InputStream input)  
      static DateTime parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DateTime parseFrom​(byte[] data)  
      static DateTime parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DateTime parseFrom​(com.google.protobuf.ByteString data)  
      static DateTime parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DateTime parseFrom​(com.google.protobuf.CodedInputStream input)  
      static DateTime parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DateTime parseFrom​(java.io.InputStream input)  
      static DateTime parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DateTime parseFrom​(java.nio.ByteBuffer data)  
      static DateTime parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<DateTime> parser()  
      DateTime.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        getYear in interface DateTimeOrBuilder
        Returns:
        The year.
      • getMonth

        public int getMonth()
         Required. Month of year. Must be from 1 to 12.
         
        int32 month = 2;
        Specified by:
        getMonth in interface DateTimeOrBuilder
        Returns:
        The month.
      • getDay

        public int getDay()
         Required. Day of month. Must be from 1 to 31 and valid for the year and
         month.
         
        int32 day = 3;
        Specified by:
        getDay in interface DateTimeOrBuilder
        Returns:
        The day.
      • 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;
        Specified by:
        getHours in interface DateTimeOrBuilder
        Returns:
        The hours.
      • getMinutes

        public int getMinutes()
         Required. Minutes of hour of day. Must be from 0 to 59.
         
        int32 minutes = 5;
        Specified by:
        getMinutes in interface DateTimeOrBuilder
        Returns:
        The minutes.
      • 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;
        Specified by:
        getSeconds in interface DateTimeOrBuilder
        Returns:
        The seconds.
      • getNanos

        public int getNanos()
         Required. Fractions of seconds in nanoseconds. Must be from 0 to
         999,999,999.
         
        int32 nanos = 7;
        Specified by:
        getNanos in interface DateTimeOrBuilder
        Returns:
        The nanos.
      • 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;
        Specified by:
        hasUtcOffset in interface DateTimeOrBuilder
        Returns:
        Whether the utcOffset field is set.
      • getUtcOffset

        public com.google.protobuf.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;
        Specified by:
        getUtcOffset in interface DateTimeOrBuilder
        Returns:
        The utcOffset.
      • getUtcOffsetOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getUtcOffsetOrBuilder in interface DateTimeOrBuilder
      • hasTimeZone

        public boolean hasTimeZone()
         Time zone.
         
        .google.type.TimeZone time_zone = 9;
        Specified by:
        hasTimeZone in interface DateTimeOrBuilder
        Returns:
        Whether the timeZone field is set.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static DateTime parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DateTime parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static DateTime parseFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static DateTime parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static DateTime parseDelimitedFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static DateTime parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static DateTime parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public DateTime.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public DateTime.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected DateTime.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static DateTime getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<DateTime> parser()
      • getParserForType

        public com.google.protobuf.Parser<DateTime> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage
      • getDefaultInstanceForType

        public DateTime getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder