Skip to content

Protocol Documentation¤

Table of Contents¤

Top

frequenz/api/common/v1/microgrid/lifetime.proto¤

Lifetime¤

Lifetime captures the timestamps indicating the active operational period of a microgrid asset, such as a component, connection, sensor, or any other entity with a limited operational lifetime.

It is normally used to track the historical evolution of assets, and it determines the validity period for the asset's data.

If the start_timestamp is not set, the asset is considered to be in operation since the beginning of the system's operational history.

If the end_timestamp is not set, the asset is considered to be in operation indefinitely into the future.

If the Lifetime message is completely missing, it means both timestamps are not set, which means the asset is considered to be in operation since the beginning of the system's operational history and indefinitely into the future.

Field Type Label Description
start_timestamp google.protobuf.Timestamp The timestamp when the asset became operationally active. If not set, the asset is considered to be in operation since the beginning of the system's operational history.
end_timestamp google.protobuf.Timestamp Optional timestamp when the asset's operational activity ceased. If not set, the asset is considered to be in operation indefinitely into the future.

Scalar Value Types¤

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)