Duration
class Duration extends Message (View source)
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".
Generated from protobuf message google.protobuf.Duration
Properties
| protected | $seconds | 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 |
|
| protected | $nanos | Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
|
Methods
Constructor.
Merges the contents of the specified message into current message.
Parses a json string to protobuf message.
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
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
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
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.
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.
Details
__construct($data = NULL)
Constructor.
protected
readWrapperValue($member)
No description
protected
writeWrapperValue($member, $value)
No description
protected
readOneof($number)
No description
protected
hasOneof($number)
No description
protected
writeOneof($number, $value)
No description
protected
whichOneof($oneof_name)
No description
clear()
Clear all containing fields.
discardUnknownFields()
Clear all unknown fields previously parsed.
mergeFrom(object $msg)
Merges the contents of the specified message into current message.
This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.
mergeFromString(string $data)
Parses a protocol buffer contained in a string.
This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
mergeFromJsonString(string $data, $ignore_unknown = false)
Parses a json string to protobuf message.
This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
parseFromStream($input)
No description
protected
mergeFromArray(array $array)
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
Example:
$message->mergeFromArray([
'name' => 'This is a message name',
'interval' => [
'startTime' => time() - 60,
'endTime' => time(),
]
]);This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.
protected
mergeFromJsonArray($array, $ignore_unknown)
No description
parseFromJsonStream($input, $ignore_unknown)
No description
serializeToStream($output)
No description
serializeToJsonStream($output)
No description
string
serializeToString()
Serialize the message to string.
string
serializeToJsonString()
Serialize the message to json string.
byteSize()
No description
jsonByteSize()
No description
int|string
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
Generated from protobuf field int64 seconds = 1;
$this
setSeconds(int|string $var)
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
Generated from protobuf field int64 seconds = 1;
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.
Generated from protobuf field int32 nanos = 2;
$this
setNanos(int $var)
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.
Generated from protobuf field int32 nanos = 2;