duration.proto 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. syntax = "proto3";
  31. package google.protobuf;
  32. option csharp_namespace = "Google.Protobuf.WellKnownTypes";
  33. option cc_enable_arenas = true;
  34. option go_package = "google.golang.org/protobuf/types/known/durationpb";
  35. option java_package = "com.google.protobuf";
  36. option java_outer_classname = "DurationProto";
  37. option java_multiple_files = true;
  38. option objc_class_prefix = "GPB";
  39. // A Duration represents a signed, fixed-length span of time represented
  40. // as a count of seconds and fractions of seconds at nanosecond
  41. // resolution. It is independent of any calendar and concepts like "day"
  42. // or "month". It is related to Timestamp in that the difference between
  43. // two Timestamp values is a Duration and it can be added or subtracted
  44. // from a Timestamp. Range is approximately +-10,000 years.
  45. //
  46. // # Examples
  47. //
  48. // Example 1: Compute Duration from two Timestamps in pseudo code.
  49. //
  50. // Timestamp start = ...;
  51. // Timestamp end = ...;
  52. // Duration duration = ...;
  53. //
  54. // duration.seconds = end.seconds - start.seconds;
  55. // duration.nanos = end.nanos - start.nanos;
  56. //
  57. // if (duration.seconds < 0 && duration.nanos > 0) {
  58. // duration.seconds += 1;
  59. // duration.nanos -= 1000000000;
  60. // } else if (duration.seconds > 0 && duration.nanos < 0) {
  61. // duration.seconds -= 1;
  62. // duration.nanos += 1000000000;
  63. // }
  64. //
  65. // Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
  66. //
  67. // Timestamp start = ...;
  68. // Duration duration = ...;
  69. // Timestamp end = ...;
  70. //
  71. // end.seconds = start.seconds + duration.seconds;
  72. // end.nanos = start.nanos + duration.nanos;
  73. //
  74. // if (end.nanos < 0) {
  75. // end.seconds -= 1;
  76. // end.nanos += 1000000000;
  77. // } else if (end.nanos >= 1000000000) {
  78. // end.seconds += 1;
  79. // end.nanos -= 1000000000;
  80. // }
  81. //
  82. // Example 3: Compute Duration from datetime.timedelta in Python.
  83. //
  84. // td = datetime.timedelta(days=3, minutes=10)
  85. // duration = Duration()
  86. // duration.FromTimedelta(td)
  87. //
  88. // # JSON Mapping
  89. //
  90. // In JSON format, the Duration type is encoded as a string rather than an
  91. // object, where the string ends in the suffix "s" (indicating seconds) and
  92. // is preceded by the number of seconds, with nanoseconds expressed as
  93. // fractional seconds. For example, 3 seconds with 0 nanoseconds should be
  94. // encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
  95. // be expressed in JSON format as "3.000000001s", and 3 seconds and 1
  96. // microsecond should be expressed in JSON format as "3.000001s".
  97. //
  98. //
  99. message Duration {
  100. // Signed seconds of the span of time. Must be from -315,576,000,000
  101. // to +315,576,000,000 inclusive. Note: these bounds are computed from:
  102. // 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
  103. int64 seconds = 1;
  104. // Signed fractions of a second at nanosecond resolution of the span
  105. // of time. Durations less than one second are represented with a 0
  106. // `seconds` field and a positive or negative `nanos` field. For durations
  107. // of one second or more, a non-zero value for the `nanos` field must be
  108. // of the same sign as the `seconds` field. Must be from -999,999,999
  109. // to +999,999,999 inclusive.
  110. int32 nanos = 2;
  111. }