github.com/polarismesh/polaris@v1.17.8/common/api/protoc/include/google/protobuf/timestamp.proto (about)

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