Class DateTime.Builder (2.41.0)

public static final class DateTime.Builder extends GeneratedMessageV3.Builder<DateTime.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DateTime.Builder

Implements

DateTimeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DateTime.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DateTime build()

Returns
Type	Description
`DateTime`

buildPartial()

public DateTime buildPartial()

Returns
Type	Description
`DateTime`

clear()

public DateTime.Builder clear()

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDay()

public DateTime.Builder clearDay()

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

int32 day = 3;

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DateTime.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHours()

public DateTime.Builder clearHours()

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
`DateTime.Builder`	This builder for chaining.

clearMinutes()

public DateTime.Builder clearMinutes()

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

int32 minutes = 5;

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

clearMonth()

public DateTime.Builder clearMonth()

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

int32 month = 2;

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

clearNanos()

public DateTime.Builder clearNanos()

Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

int32 nanos = 7;

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DateTime.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSeconds()

public DateTime.Builder clearSeconds()

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
`DateTime.Builder`	This builder for chaining.

clearTimeOffset()

public DateTime.Builder clearTimeOffset()

Returns
Type	Description
`DateTime.Builder`

clearTimeZone()

public DateTime.Builder clearTimeZone()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
Type	Description
`DateTime.Builder`

clearUtcOffset()

public DateTime.Builder clearUtcOffset()

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
`DateTime.Builder`

clearYear()

public DateTime.Builder clearYear()

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
`DateTime.Builder`	This builder for chaining.

clone()

public DateTime.Builder clone()

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

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.

getTimeZoneBuilder()

public TimeZone.Builder getTimeZoneBuilder()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
Type	Description
`TimeZone.Builder`

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.

getUtcOffsetBuilder()

public Duration.Builder getUtcOffsetBuilder()

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
`Builder`

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DateTime.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`DateTime.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DateTime.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DateTime.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(DateTime other)

public DateTime.Builder mergeFrom(DateTime other)

Parameter
Name	Description
`other`	`DateTime`

Returns
Type	Description
`DateTime.Builder`

mergeTimeZone(TimeZone value)

public DateTime.Builder mergeTimeZone(TimeZone value)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
Name	Description
`value`	`TimeZone`

Returns
Type	Description
`DateTime.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DateTime.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUtcOffset(Duration value)

public DateTime.Builder mergeUtcOffset(Duration value)

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;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`DateTime.Builder`

setDay(int value)

public DateTime.Builder setDay(int value)

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

int32 day = 3;

Parameter
Name	Description
`value`	`int` The day to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DateTime.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHours(int value)

public DateTime.Builder setHours(int value)

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;

Parameter
Name	Description
`value`	`int` The hours to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setMinutes(int value)

public DateTime.Builder setMinutes(int value)

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

int32 minutes = 5;

Parameter
Name	Description
`value`	`int` The minutes to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setMonth(int value)

public DateTime.Builder setMonth(int value)

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

int32 month = 2;

Parameter
Name	Description
`value`	`int` The month to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setNanos(int value)

public DateTime.Builder setNanos(int value)

Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

int32 nanos = 7;

Parameter
Name	Description
`value`	`int` The nanos to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DateTime.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSeconds(int value)

public DateTime.Builder setSeconds(int value)

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;

Parameter
Name	Description
`value`	`int` The seconds to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.

setTimeZone(TimeZone value)

public DateTime.Builder setTimeZone(TimeZone value)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
Name	Description
`value`	`TimeZone`

Returns
Type	Description
`DateTime.Builder`

setTimeZone(TimeZone.Builder builderForValue)

public DateTime.Builder setTimeZone(TimeZone.Builder builderForValue)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
Name	Description
`builderForValue`	`TimeZone.Builder`

Returns
Type	Description
`DateTime.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final DateTime.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DateTime.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUtcOffset(Duration value)

public DateTime.Builder setUtcOffset(Duration value)

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;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`DateTime.Builder`

setUtcOffset(Duration.Builder builderForValue)

public DateTime.Builder setUtcOffset(Duration.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DateTime.Builder`

setYear(int value)

public DateTime.Builder setYear(int value)

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

int32 year = 1;

Parameter
Name	Description
`value`	`int` The year to set.

Returns
Type	Description
`DateTime.Builder`	This builder for chaining.