Class Duration (3.19.4) 

public final class Duration extends GeneratedMessageLite<Duration,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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > GeneratedMessageLite > Duration

Implements

DurationOrBuilder

Static Fields

NANOS_FIELD_NUMBER

public static final int NANOS_FIELD_NUMBER
Field Value
Type Description
int

SECONDS_FIELD_NUMBER

public static final int SECONDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Duration getDefaultInstance()
Returns
Type Description
Duration

newBuilder()

public static Duration.Builder newBuilder()
Returns
Type Description
Duration.Builder

newBuilder(Duration prototype)

public static Duration.Builder newBuilder(Duration prototype)
Parameter
Name Description
prototype Duration
Returns
Type Description
Duration.Builder

parseDelimitedFrom(InputStream input)

public static Duration parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Duration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Duration parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Duration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Duration parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Duration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Duration parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Duration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Duration parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Duration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Duration parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Duration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Duration
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Duration> parser()
Returns
Type Description
Parser<Duration>

Methods

dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

A method that implements different types of operations described in MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.

  • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
  • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
  • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
  • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
  • NEW_BUILDER returns a BuilderType instance.

This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

For use by generated code only.

Parameters
Name Description
method GeneratedMessageLite.MethodToInvoke
arg0 Object
arg1 Object
Returns
Type Description
Object
Overrides

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;

Returns
Type Description
int

The nanos.

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;

Returns
Type Description
long

The seconds.