timestamp.proto 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  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 = "github.com/golang/protobuf/ptypes/timestamp";
  35. option java_package = "com.google.protobuf";
  36. option java_outer_classname = "TimestampProto";
  37. option java_multiple_files = true;
  38. option objc_class_prefix = "GPB";
  39. // A Timestamp represents a point in time independent of any time zone
  40. // or calendar, represented as seconds and fractions of seconds at
  41. // nanosecond resolution in UTC Epoch time. It is encoded using the
  42. // Proleptic Gregorian Calendar which extends the Gregorian calendar
  43. // backwards to year one. It is encoded assuming all minutes are 60
  44. // seconds long, i.e. leap seconds are "smeared" so that no leap second
  45. // table is needed for interpretation. Range is from
  46. // 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
  47. // By restricting to that range, we ensure that we can convert to
  48. // and from RFC 3339 date strings.
  49. // See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
  50. //
  51. // # Examples
  52. //
  53. // Example 1: Compute Timestamp from POSIX `time()`.
  54. //
  55. // Timestamp timestamp;
  56. // timestamp.set_seconds(time(NULL));
  57. // timestamp.set_nanos(0);
  58. //
  59. // Example 2: Compute Timestamp from POSIX `gettimeofday()`.
  60. //
  61. // struct timeval tv;
  62. // gettimeofday(&tv, NULL);
  63. //
  64. // Timestamp timestamp;
  65. // timestamp.set_seconds(tv.tv_sec);
  66. // timestamp.set_nanos(tv.tv_usec * 1000);
  67. //
  68. // Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
  69. //
  70. // FILETIME ft;
  71. // GetSystemTimeAsFileTime(&ft);
  72. // UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
  73. //
  74. // // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
  75. // // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
  76. // Timestamp timestamp;
  77. // timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
  78. // timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
  79. //
  80. // Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
  81. //
  82. // long millis = System.currentTimeMillis();
  83. //
  84. // Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
  85. // .setNanos((int) ((millis % 1000) * 1000000)).build();
  86. //
  87. //
  88. // Example 5: Compute Timestamp from current time in Python.
  89. //
  90. // timestamp = Timestamp()
  91. // timestamp.GetCurrentTime()
  92. //
  93. // # JSON Mapping
  94. //
  95. // In JSON format, the Timestamp type is encoded as a string in the
  96. // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
  97. // format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
  98. // where {year} is always expressed using four digits while {month}, {day},
  99. // {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
  100. // seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
  101. // are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
  102. // is required. A proto3 JSON serializer should always use UTC (as indicated by
  103. // "Z") when printing the Timestamp type and a proto3 JSON parser should be
  104. // able to accept both UTC and other timezones (as indicated by an offset).
  105. //
  106. // For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
  107. // 01:30 UTC on January 15, 2017.
  108. //
  109. // In JavaScript, one can convert a Date object to this format using the
  110. // standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
  111. // method. In Python, a standard `datetime.datetime` object can be converted
  112. // to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
  113. // with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
  114. // can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
  115. // http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
  116. // ) to obtain a formatter capable of generating timestamps in this format.
  117. //
  118. //
  119. message Timestamp {
  120. // Represents seconds of UTC time since Unix epoch
  121. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  122. // 9999-12-31T23:59:59Z inclusive.
  123. int64 seconds = 1;
  124. // Non-negative fractions of a second at nanosecond resolution. Negative
  125. // second values with fractions must still have non-negative nanos values
  126. // that count forward in time. Must be from 0 to 999,999,999
  127. // inclusive.
  128. int32 nanos = 2;
  129. }