timestamppb
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package timestamppb contains generated types for google/protobuf/timestamp.proto.
The Timestamp message represents a timestamp,an instant in time since the Unix epoch (January 1st, 1970).
Conversion to a Go Time¶
The AsTime method can be used to convert a Timestamp message to astandard Go time.Time value in UTC:
t := ts.AsTime()... // make use of t as a time.Time
Converting to a time.Time is a common operation so that the extensiveset of time-based operations provided by the time package can be leveraged.Seehttps://golang.org/pkg/time for more information.
The AsTime method performs the conversion on a best-effort basis. Timestampswith denormal values (e.g., nanoseconds beyond 0 and 99999999, inclusive)are normalized during the conversion to a time.Time. To manually check forinvalid Timestamps per the documented limitations in timestamp.proto,additionally call the CheckValid method:
if err := ts.CheckValid(); err != nil {... // handle error}Conversion from a Go Time¶
The timestamppb.New function can be used to construct a Timestamp messagefrom a standard Go time.Time value:
ts := timestamppb.New(t)... // make use of ts as a *timestamppb.Timestamp
In order to construct a Timestamp representing the current time, use Now:
ts := timestamppb.Now()... // make use of ts as a *timestamppb.Timestamp
Index¶
- Variables
- type Timestamp
- func (x *Timestamp) AsTime() time.Time
- func (x *Timestamp) CheckValid() error
- func (*Timestamp) Descriptor() ([]byte, []int)deprecated
- func (x *Timestamp) GetNanos() int32
- func (x *Timestamp) GetSeconds() int64
- func (x *Timestamp) IsValid() bool
- func (*Timestamp) ProtoMessage()
- func (x *Timestamp) ProtoReflect() protoreflect.Message
- func (x *Timestamp) Reset()
- func (x *Timestamp) String() string
Constants¶
This section is empty.
Variables¶
var File_google_protobuf_timestamp_protoprotoreflect.FileDescriptorFunctions¶
This section is empty.
Types¶
typeTimestamp¶
type Timestamp struct {// Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must// be between -315576000000 and 315576000000 inclusive (which corresponds to// 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).Secondsint64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`// Non-negative fractions of a second at nanosecond resolution. This field is// the nanosecond portion of the duration, not an alternative to seconds.// Negative second values with fractions must still have non-negative nanos// values that count forward in time. Must be between 0 and 999,999,999// inclusive.Nanosint32 `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`// contains filtered or unexported fields}A Timestamp represents a point in time independent of any time zone or localcalendar, encoded as a count of seconds and fractions of seconds atnanosecond resolution. The count is relative to an epoch at UTC midnight onJanuary 1, 1970, in the proleptic Gregorian calendar which extends theGregorian calendar backwards to year one.
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leapsecond table is needed for interpretation, using a [24-hour linearsmear](https://developers.google.com/time/smear).
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. Byrestricting to that range, we ensure that we can convert to and from [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
Examples¶
Example 1: Compute Timestamp from POSIX `time()`.
Timestamp timestamp;timestamp.set_seconds(time(NULL));timestamp.set_nanos(0);
Example 2: Compute Timestamp from POSIX `gettimeofday()`.
struct timeval tv;gettimeofday(&tv, NULL);Timestamp timestamp;timestamp.set_seconds(tv.tv_sec);timestamp.set_nanos(tv.tv_usec * 1000);
Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
FILETIME ft;GetSystemTimeAsFileTime(&ft);UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.Timestamp timestamp;timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
long millis = System.currentTimeMillis();Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
Example 5: Compute Timestamp from Java `Instant.now()`.
Instant now = Instant.now();Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build();
Example 6: Compute Timestamp from current time in Python.
timestamp = Timestamp()timestamp.GetCurrentTime()
JSON Mapping¶
In JSON format, the Timestamp type is encoded as a string in the[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, theformat is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"where {year} is always expressed using four digits while {month}, {day},{hour}, {min}, and {sec} are zero-padded to two digits each. The fractionalseconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),are optional. The "Z" suffix indicates the timezone ("UTC"); the timezoneis required. A proto3 JSON serializer should always use UTC (as indicated by"Z") when printing the Timestamp type and a proto3 JSON parser should beable to accept both UTC and other timezones (as indicated by an offset).
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past01:30 UTC on January 15, 2017.
In JavaScript, one can convert a Date object to this format using thestandard[toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)method. In Python, a standard `datetime.datetime` object can be convertedto this format using[`strftime`](https://docs.python.org/2/library/time.html#time.strftime) withthe time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can usethe Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a formatter capable of generating timestamps in this format.
func (*Timestamp)CheckValid¶added inv1.25.0
CheckValid returns an error if the timestamp is invalid.In particular, it checks whether the value represents a date that isin the range of 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.An error is reported for a nil Timestamp.
func (*Timestamp)Descriptordeprecated
func (*Timestamp)GetSeconds¶
func (*Timestamp)IsValid¶added inv1.25.0
IsValid reports whether the timestamp is valid.It is equivalent to CheckValid == nil.
func (*Timestamp)ProtoMessage¶
func (*Timestamp) ProtoMessage()
func (*Timestamp)ProtoReflect¶
func (x *Timestamp) ProtoReflect()protoreflect.Message