Class DateTime.Builder (2.9.1)

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

Implements

DateTimeOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DateTime.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DateTime.Builder
Overrides

build()

public DateTime build()
Returns
TypeDescription
DateTime

buildPartial()

public DateTime buildPartial()
Returns
TypeDescription
DateTime

clear()

public DateTime.Builder clear()
Returns
TypeDescription
DateTime.Builder
Overrides

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DateTime.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DateTime.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DateTime.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DateTime.Builder
Overrides

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

This builder for chaining.

clearTimeOffset()

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

clearTimeZone()

public DateTime.Builder clearTimeZone()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DateTime.Builder

This builder for chaining.

clone()

public DateTime.Builder clone()
Returns
TypeDescription
DateTime.Builder
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.

getDefaultInstanceForType()

public DateTime getDefaultInstanceForType()
Returns
TypeDescription
DateTime

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

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.

getTimeZoneBuilder()

public TimeZone.Builder getTimeZoneBuilder()

Time zone.

.google.type.TimeZone time_zone = 9;

Returns
TypeDescription
TimeZone.Builder

getTimeZoneOrBuilder()

public TimeZoneOrBuilder getTimeZoneOrBuilder()

Time zone.

.google.type.TimeZone time_zone = 9;

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DateTime.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DateTime.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DateTime.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DateTime.Builder
Overrides

mergeFrom(DateTime other)

public DateTime.Builder mergeFrom(DateTime other)
Parameter
NameDescription
otherDateTime
Returns
TypeDescription
DateTime.Builder

mergeTimeZone(TimeZone value)

public DateTime.Builder mergeTimeZone(TimeZone value)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
NameDescription
valueTimeZone
Returns
TypeDescription
DateTime.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DateTime.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DateTime.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
valueint

The day to set.

Returns
TypeDescription
DateTime.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DateTime.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DateTime.Builder
Overrides

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
NameDescription
valueint

The hours to set.

Returns
TypeDescription
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
NameDescription
valueint

The minutes to set.

Returns
TypeDescription
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
NameDescription
valueint

The month to set.

Returns
TypeDescription
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
NameDescription
valueint

The nanos to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DateTime.Builder
Overrides

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
NameDescription
valueint

The seconds to set.

Returns
TypeDescription
DateTime.Builder

This builder for chaining.

setTimeZone(TimeZone value)

public DateTime.Builder setTimeZone(TimeZone value)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
NameDescription
valueTimeZone
Returns
TypeDescription
DateTime.Builder

setTimeZone(TimeZone.Builder builderForValue)

public DateTime.Builder setTimeZone(TimeZone.Builder builderForValue)

Time zone.

.google.type.TimeZone time_zone = 9;

Parameter
NameDescription
builderForValueTimeZone.Builder
Returns
TypeDescription
DateTime.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DateTime.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DateTime.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueint

The year to set.

Returns
TypeDescription
DateTime.Builder

This builder for chaining.