temporal_range.proto

// Copyright 2020-2024 SIX AFTER, INC (SIX AFTER)
//
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: SIX AFTER, INC (SIX AFTER)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax="proto3";

package sixafter.types;

option go_package="github.com/sixafter/types;types";
option cc_enable_arenas = true;
option java_package = "com.sixafter.types";
option java_multiple_files = true;
option java_outer_classname = "TemporalRangeProto";
option objc_class_prefix = "TPB";
option csharp_namespace = "SixAfter.Types.WellKnownTypes";

import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";

// The `TemporalRange` message represents a time range defined by a starting
// reference point (epoch) and a duration. It is commonly used in time-based
// applications such as scheduling, analytics, and temporal data analysis.
message TemporalRange {

  // The starting point of the temporal range, known as the epoch.
  // This timestamp serves as the reference point from which the duration is
  // measured.
  // Example: "2024-11-17T00:00:00Z" for a midnight reference point in UTC.
  google.protobuf.Timestamp epoch = 1;

  // The duration of the temporal range, measured as the time span from the
  // epoch. This represents the length of the time range.
  // Example: A duration of `3600 seconds` (1 hour) indicates a range lasting
  // one hour from the epoch.
  google.protobuf.Duration duration = 2;
}