Duration.Builder (Protocol Buffers [Core] 3.18.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Duration.Builder>
    - - com.google.protobuf.Duration.Builder

All Implemented Interfaces:: DurationOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:: Duration

public static final class Duration.Builder
extends GeneratedMessageV3.Builder<Duration.Builder>
implements DurationOrBuilder

 A Duration represents a signed, fixed-length span of time represented
 as a count of seconds and fractions of seconds at nanosecond
 resolution. It is independent of any calendar and concepts like "day"
 or "month". It is related to Timestamp in that the difference between
 two Timestamp values is a Duration and it can be added or subtracted
 from a Timestamp. Range is approximately +-10,000 years.
 # Examples
 Example 1: Compute Duration from two Timestamps in pseudo code.
     Timestamp start = ...;
     Timestamp end = ...;
     Duration duration = ...;
     duration.seconds = end.seconds - start.seconds;
     duration.nanos = end.nanos - start.nanos;
     if (duration.seconds < 0 && duration.nanos > 0) {
       duration.seconds += 1;
       duration.nanos -= 1000000000;
     } else if (duration.seconds > 0 && duration.nanos < 0) {
       duration.seconds -= 1;
       duration.nanos += 1000000000;
     }
 Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
     Timestamp start = ...;
     Duration duration = ...;
     Timestamp end = ...;
     end.seconds = start.seconds + duration.seconds;
     end.nanos = start.nanos + duration.nanos;
     if (end.nanos < 0) {
       end.seconds -= 1;
       end.nanos += 1000000000;
     } else if (end.nanos >= 1000000000) {
       end.seconds += 1;
       end.nanos -= 1000000000;
     }
 Example 3: Compute Duration from datetime.timedelta in Python.
     td = datetime.timedelta(days=3, minutes=10)
     duration = Duration()
     duration.FromTimedelta(td)
 # JSON Mapping
 In JSON format, the Duration type is encoded as a string rather than an
 object, where the string ends in the suffix "s" (indicating seconds) and
 is preceded by the number of seconds, with nanoseconds expressed as
 fractional seconds. For example, 3 seconds with 0 nanoseconds should be
 encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
 be expressed in JSON format as "3.000000001s", and 3 seconds and 1
 microsecond should be expressed in JSON format as "3.000001s".

Protobuf type google.protobuf.Duration

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Duration.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)` Like `setRepeatedField`, but appends the value as a new element.
`Duration`	`build()` Constructs the message based on the state of the Builder.
`Duration`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Duration.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Duration.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`Duration.Builder`	`clearNanos()` Signed fractions of a second at nanosecond resolution of the span of time.
`Duration.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)` TODO(jieluo): Clear it when all subclasses have implemented this method.
`Duration.Builder`	`clearSeconds()` Signed seconds of the span of time.
`Duration.Builder`	`clone()` Clones the Builder.
`Duration`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`int`	`getNanos()` Signed fractions of a second at nanosecond resolution of the span of time.
`long`	`getSeconds()` Signed seconds of the span of time.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Duration.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Duration.Builder`	`mergeFrom(Duration other)`
`Duration.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Duration.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`Duration.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)` Sets a field to the given value.
`Duration.Builder`	`setNanos(int value)` Signed fractions of a second at nanosecond resolution of the span of time.
`Duration.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)` Sets an element of a repeated field to the given value.
`Duration.Builder`	`setSeconds(long value)` Signed seconds of the span of time.
`Duration.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Duration.Builder>
  - clear
```
public Duration.Builder clear()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessageV3.Builder<Duration.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessageV3.Builder<Duration.Builder>
  - getDefaultInstanceForType
```
public Duration getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder
  - build
```
public Duration build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Duration buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - clone
```
public Duration.Builder clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessageV3.Builder<Duration.Builder>
    
    See Also:
    
    Object.clone()
  - setField
```
public Duration.Builder setField(Descriptors.FieldDescriptor field,
                                 Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
    
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class GeneratedMessageV3.Builder<Duration.Builder>
  - clearField
```
public Duration.Builder clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
    
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class GeneratedMessageV3.Builder<Duration.Builder>
  - clearOneof
```
public Duration.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Description copied from class: AbstractMessage.Builder
    
    TODO(jieluo): Clear it when all subclasses have implemented this method.
    
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class GeneratedMessageV3.Builder<Duration.Builder>
  - setRepeatedField
```
public Duration.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
```
    Description copied from interface: Message.Builder
    
    Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
    
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class GeneratedMessageV3.Builder<Duration.Builder>
  - addRepeatedField
```
public Duration.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                         Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
    
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class GeneratedMessageV3.Builder<Duration.Builder>
  - mergeFrom
```
public Duration.Builder mergeFrom(Message other)
```
    Description copied from interface: Message.Builder
    
    Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).
    Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message.
    * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.
    This is equivalent to the Message::MergeFrom method in C++.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Duration.Builder>
  - mergeFrom
```
public Duration.Builder mergeFrom(Duration other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3.Builder<Duration.Builder>
  - mergeFrom
```
public Duration.Builder mergeFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Duration.Builder>
    
    Throws:
    
    IOException
  - getSeconds
```
public long getSeconds()
```
```
 Signed seconds of the span of time. Must be from -315,576,000,000
 to +315,576,000,000 inclusive. Note: these bounds are computed from:
 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
 
```
    int64 seconds = 1;
    Specified by:
    
    getSeconds in interface DurationOrBuilder
    
    Returns:
    
    The seconds.
  - setSeconds
```
public Duration.Builder setSeconds(long value)
```
```
 Signed seconds of the span of time. Must be from -315,576,000,000
 to +315,576,000,000 inclusive. Note: these bounds are computed from:
 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
 
```
    int64 seconds = 1;
    Parameters:
    
    value - The seconds to set.
    
    Returns:
    
    This builder for chaining.
  - clearSeconds
```
public Duration.Builder clearSeconds()
```
```
 Signed seconds of the span of time. Must be from -315,576,000,000
 to +315,576,000,000 inclusive. Note: these bounds are computed from:
 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
 
```
    int64 seconds = 1;
    Returns:
    
    This builder for chaining.
  - getNanos
```
public int getNanos()
```
```
 Signed fractions of a second at nanosecond resolution of the span
 of time. Durations less than one second are represented with a 0
 `seconds` field and a positive or negative `nanos` field. For durations
 of one second or more, a non-zero value for the `nanos` field must be
 of the same sign as the `seconds` field. Must be from -999,999,999
 to +999,999,999 inclusive.
 
```
    int32 nanos = 2;
    Specified by:
    
    getNanos in interface DurationOrBuilder
    
    Returns:
    
    The nanos.
  - setNanos
```
public Duration.Builder setNanos(int value)
```
```
 Signed fractions of a second at nanosecond resolution of the span
 of time. Durations less than one second are represented with a 0
 `seconds` field and a positive or negative `nanos` field. For durations
 of one second or more, a non-zero value for the `nanos` field must be
 of the same sign as the `seconds` field. Must be from -999,999,999
 to +999,999,999 inclusive.
 
```
    int32 nanos = 2;
    Parameters:
    
    value - The nanos to set.
    
    Returns:
    
    This builder for chaining.
  - clearNanos
```
public Duration.Builder clearNanos()
```
```
 Signed fractions of a second at nanosecond resolution of the span
 of time. Durations less than one second are represented with a 0
 `seconds` field and a positive or negative `nanos` field. For durations
 of one second or more, a non-zero value for the `nanos` field must be
 of the same sign as the `seconds` field. Must be from -999,999,999
 to +999,999,999 inclusive.
 
```
    int32 nanos = 2;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Duration.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessageV3.Builder<Duration.Builder>
  - mergeUnknownFields
```
public final Duration.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessageV3.Builder<Duration.Builder>

Class Duration.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getSeconds

setSeconds

clearSeconds

getNanos

setNanos

clearNanos

setUnknownFields

mergeUnknownFields