Documentation
¶
Index ¶
- Variables
- type Timestamp
- func (x *Timestamp) AsRFC3339() string
- func (x *Timestamp) AsTime() time.Time
- func (x *Timestamp) CheckValid() error
- func (m *Timestamp) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Timestamp) CloneVT() *Timestamp
- func (this *Timestamp) EqualMessageVT(thatMsg any) bool
- func (this *Timestamp) EqualVT(that *Timestamp) bool
- func (x *Timestamp) GetEmpty() bool
- func (x *Timestamp) GetNanos() int32
- func (x *Timestamp) GetSeconds() int64
- func (x *Timestamp) IsValid() bool
- func (x *Timestamp) MarshalJSON() ([]byte, error)
- func (x *Timestamp) MarshalProtoJSON(s *json.MarshalState)
- func (t *Timestamp) MarshalProtoText() string
- func (m *Timestamp) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Timestamp) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)
- func (m *Timestamp) MarshalToVT(dAtA []byte) (int, error)
- func (m *Timestamp) MarshalToVTStrict(dAtA []byte) (int, error)
- func (m *Timestamp) MarshalVT() (dAtA []byte, err error)
- func (m *Timestamp) MarshalVTStrict() (dAtA []byte, err error)
- func (*Timestamp) ProtoMessage()
- func (x *Timestamp) Reset()
- func (m *Timestamp) SizeVT() (n int)
- func (t *Timestamp) String() string
- func (x *Timestamp) UnmarshalJSON(b []byte) error
- func (x *Timestamp) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Timestamp) UnmarshalVT(dAtA []byte) error
- func (m *Timestamp) UnmarshalVTUnsafe(dAtA []byte) error
- func (x *Timestamp) Validate(allowEmpty bool) error
Constants ¶
This section is empty.
Variables ¶
var ErrEmptyTimestamp = errors.New("empty timestamp")
ErrEmptyTimestamp is returned from Validate if the timestamp was empty.
Functions ¶
This section is empty.
Types ¶
type Timestamp ¶
type Timestamp struct {
// Represents seconds of UTC time since Unix epoch
// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
// 9999-12-31T23:59:59Z inclusive.
Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
// Non-negative fractions of a second at nanosecond resolution. Negative
// second values with fractions must still have non-negative nanos values
// that count forward in time. Must be from 0 to 999,999,999
// inclusive.
Nanos int32 `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 local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear).
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](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, the format 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 fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.
In JavaScript, one can convert a Date object to this format using the standard [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 converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the 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.
protobuf-go-lite:disable-text
func FromUnixMilli ¶ added in v0.7.0
FromUnixMilli constructs a new Timestamp from the provided unix milliseconds value.
Example: time.Now().UnixMilli()
func ToTimestamp ¶ added in v0.4.9
ToTimestamp constructs a new Timestamp from the provided time.Time.
func (*Timestamp) AsRFC3339 ¶ added in v0.4.7
AsRFC3339 returns the timestamp formatted as an RFC3339 string.
func (*Timestamp) CheckValid ¶
CheckValid returns an error if the timestamp is invalid. In particular, it checks whether the value represents a date that is in 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) CloneMessageVT ¶ added in v0.2.1
func (m *Timestamp) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Timestamp) EqualMessageVT ¶ added in v0.2.1
func (*Timestamp) GetSeconds ¶
func (*Timestamp) IsValid ¶
IsValid reports whether the timestamp is valid. It is equivalent to CheckValid == nil.
func (*Timestamp) MarshalJSON ¶ added in v0.3.0
MarshalJSON marshals the Timestamp to JSON.
func (*Timestamp) MarshalProtoJSON ¶ added in v0.3.0
func (x *Timestamp) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals a Timestamp to JSON.
func (*Timestamp) MarshalProtoText ¶ added in v0.5.0
MarshalProtoText formats the Timestamp to a proto text string.
func (*Timestamp) MarshalToSizedBufferVT ¶ added in v0.2.1
func (*Timestamp) MarshalToSizedBufferVTStrict ¶ added in v0.2.1
func (*Timestamp) MarshalToVT ¶ added in v0.2.1
func (*Timestamp) MarshalToVTStrict ¶ added in v0.2.1
func (*Timestamp) MarshalVTStrict ¶ added in v0.2.1
func (*Timestamp) ProtoMessage ¶
func (*Timestamp) ProtoMessage()
func (*Timestamp) UnmarshalJSON ¶ added in v0.4.0
UnmarshalJSON unmarshals the Timestamp from JSON.
func (*Timestamp) UnmarshalProtoJSON ¶ added in v0.4.0
func (x *Timestamp) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals a Timestamp from JSON.
Source Files