Skip to content

Timestamp rules#

TimestampRules describe the rules applied exclusively to the google.protobuf.Timestamp well-known type.

const#

const dictates that this field, of the google.protobuf.Timestamp type, must exactly match the specified value. If the field value doesn't correspond to the specified timestamp, an error message will be generated.

timestamp.const example
message MyTimestamp {
  // value must equal 2023-05-03T10:00:00Z
  google.protobuf.Timestamp created_at = 1 [(buf.validate.field).timestamp.const = {seconds: 1727998800}];
}

lt#

requires the duration field value to be less than the specified value (field < value). If the field value doesn't meet the required conditions, an error message is generated.

timestamp.lt example
message MyDuration {
  // duration must be less than 'P3D' [duration.lt]
  google.protobuf.Duration value = 1 [(buf.validate.field).duration.lt = { seconds: 259200 }];
}

lte#

requires the timestamp field value to be less than or equal to the specified value (field <= value). If the field value doesn't meet the required conditions, an error message is generated.

timestamp.lte example
message MyTimestamp {
  // timestamp must be less than or equal to '2023-05-14T00:00:00Z' [timestamp.lte]
  google.protobuf.Timestamp value = 1 [(buf.validate.field).timestamp.lte = { seconds: 1678867200 }];
}

lt_now#

lt_now specifies that this field, of the google.protobuf.Timestamp type, must be less than the current time. lt_now can only be used with the within rule.

timestamp.lt_now example
message MyTimestamp {
 // value must be less than now
  google.protobuf.Timestamp created_at = 1 [(buf.validate.field).timestamp.lt_now = true];
}

gt#

gt requires the timestamp field value to be greater than the specified value (exclusive). If the value of gt is larger than a specified lt or lte, the range is reversed, and the field value must be outside the specified range. If the field value doesn't meet the required conditions, an error message is generated.

timestamp.gt example
message MyTimestamp {
  // timestamp must be greater than '2023-01-01T00:00:00Z' [timestamp.gt]
  google.protobuf.Timestamp value = 1 [(buf.validate.field).timestamp.gt = { seconds: 1672444800 }];

  // timestamp must be greater than '2023-01-01T00:00:00Z' and less than '2023-01-02T00:00:00Z' [timestamp.gt_lt]
  google.protobuf.Timestamp another_value = 2 [(buf.validate.field).timestamp = { gt: { seconds: 1672444800 }, lt: { seconds: 1672531200 } }];

  // timestamp must be greater than '2023-01-02T00:00:00Z' or less than '2023-01-01T00:00:00Z' [timestamp.gt_lt_exclusive]
  google.protobuf.Timestamp other_value = 3 [(buf.validate.field).timestamp = { gt: { seconds: 1672531200 }, lt: { seconds: 1672444800 } }];
}

gte#

gte requires the timestamp field value to be greater than or equal to the specified value (exclusive). If the value of gte is larger than a specified lt or lte, the range is reversed, and the field value must be outside the specified range. If the field value doesn't meet the required conditions, an error message is generated.

timestamp.gte example
message MyTimestamp {
  // timestamp must be greater than or equal to '2023-01-01T00:00:00Z' [timestamp.gte]
  google.protobuf.Timestamp value = 1 [(buf.validate.field).timestamp.gte = { seconds: 1672444800 }];

  // timestamp must be greater than or equal to '2023-01-01T00:00:00Z' and less than '2023-01-02T00:00:00Z' [timestamp.gte_lt]
  google.protobuf.Timestamp another_value = 2 [(buf.validate.field).timestamp = { gte: { seconds: 1672444800 }, lt: { seconds: 1672531200 } }];

  // timestamp must be greater than or equal to '2023-01-02T00:00:00Z' or less than '2023-01-01T00:00:00Z' [timestamp.gte_lt_exclusive]
  google.protobuf.Timestamp other_value = 3 [(buf.validate.field).timestamp = { gte: { seconds: 1672531200 }, lt: { seconds: 1672444800 } }];
}

gt_now#

gt_now specifies that this field, of the google.protobuf.Timestamp type, must be greater than the current time. gt_now can only be used with the within rule.

timestamp.gt_now example
message MyTimestamp {
  // value must be greater than now
  google.protobuf.Timestamp created_at = 1 [(buf.validate.field).timestamp.gt_now = true];
}

within#

within specifies that this field, of the google.protobuf.Timestamp type, must be within the specified duration of the current time. If the field value isn't within the duration, an error message is generated.

timestamp.within example
message MyTimestamp {
  // value must be within 1 hour of now
  google.protobuf.Timestamp created_at = 1 [(buf.validate.field).timestamp.within = {seconds: 3600}];
}

example#

example specifies values that the field may have. These values SHOULD conform to other rules. example values will not impact validation but may be used as helpful guidance on how to populate the given field.

timestamp.example example
message MyTimestamp {
  google.protobuf.Timestamp value = 1 [
    (buf.validate.field).timestamp.example = { seconds: 1672444800 },
    (buf.validate.field).timestamp.example = { seconds: 1672531200 },
  ];
}