Documentation
¶
Index ¶
- type Timestamp
- func (*Timestamp) Descriptor() ([]byte, []int)
- func (m *Timestamp) GetNanos() int32
- func (m *Timestamp) GetSeconds() int64
- func (m *Timestamp) GoogleTimestamp() *google_tspb.Timestamp
- func (*Timestamp) ProtoMessage()
- func (m *Timestamp) RFC3339() string
- func (m *Timestamp) Reset()
- func (m *Timestamp) Scan(value interface{}) error
- func (m *Timestamp) SetToGoogleTimestamp(ts *google_tspb.Timestamp) *Timestamp
- func (m *Timestamp) SetToNow() *Timestamp
- func (m *Timestamp) SetToString(layout string, dateValue string) (*Timestamp, error)
- func (m *Timestamp) SetToTime(t time.Time) (*Timestamp, error)
- func (m *Timestamp) String() string
- func (m *Timestamp) Time() (time.Time, error)
- func (m *Timestamp) ValidateTimestamp() error
- func (m Timestamp) Value() (driver.Value, error)
- func (m *Timestamp) XXX_DiscardUnknown()
- func (m *Timestamp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Timestamp) XXX_Merge(src proto.Message)
- func (m *Timestamp) XXX_Size() int
- func (m *Timestamp) XXX_Unmarshal(b []byte) error
- func (*Timestamp) XXX_WellKnownType() string
Constants ¶
This section is empty.
Variables ¶
This section is 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"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. 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 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
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 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter capable of generating timestamps in this format.
func (*Timestamp) Descriptor ¶
func (*Timestamp) GetSeconds ¶
func (*Timestamp) GoogleTimestamp ¶
func (m *Timestamp) GoogleTimestamp() *google_tspb.Timestamp
GoogleTimestamp converts the veqryn.protobuf.Timestamp proto into a google.protobuf.Timestamp proto
func (*Timestamp) ProtoMessage ¶
func (*Timestamp) ProtoMessage()
func (*Timestamp) RFC3339 ¶
RFC3339 returns the RFC 3339 string for valid Timestamps. For invalid Timestamps, it returns an error message in parentheses.
func (*Timestamp) SetToGoogleTimestamp ¶
func (m *Timestamp) SetToGoogleTimestamp(ts *google_tspb.Timestamp) *Timestamp
SetToGoogleTimestamp sets and returns the veqryn.protobuf.Timestamp proto to a google.protobuf.Timestamp proto
func (*Timestamp) SetToNow ¶
SetToNow sets and returns the veqryn.protobuf.Timestamp for the current time.
func (*Timestamp) SetToString ¶
SetToString sets and returns the veqryn.protobuf.Timestamp proto to a time string with the given layout
func (*Timestamp) SetToTime ¶
SetFromTime sets and returns the veqryn.protobuf.Timestamp proto to the time.Time. It returns an error if the resulting Timestamp is invalid.
func (*Timestamp) Time ¶
Time converts the veqryn.protobuf.Timestamp proto to a time.Time. It returns an error if the argument is invalid.
Unlike most Go functions, if Timestamp returns an error, the first return value is not the zero time.Time. Instead, it is the value obtained from the time.Unix function when passed the contents of the Timestamp, in the UTC locale. This may or may not be a meaningful time; many invalid Timestamps do map to valid time.Times.
A nil Timestamp returns an error. The first return value in that case is undefined.
func (*Timestamp) ValidateTimestamp ¶
validateTimestamp determines whether a Timestamp is valid. A valid timestamp represents a time in the range [0001-01-01, 10000-01-01) and has a Nanos field in the range [0, 1e9).
If the Timestamp is valid, validateTimestamp returns nil. Otherwise, it returns an error that describes the problem.
Every valid Timestamp can be represented by a time.Time, but the converse is not true.
func (*Timestamp) XXX_DiscardUnknown ¶
func (m *Timestamp) XXX_DiscardUnknown()
func (*Timestamp) XXX_Marshal ¶
func (*Timestamp) XXX_Unmarshal ¶
func (*Timestamp) XXX_WellKnownType ¶
XXX_WellKnownType allows this non-Google timestamp protobuf to interact properly with jsonpb and other libraries as it is was the standard WKT timestamp.
Source Files