THE LINUX FOUNDATION PROJECTS
FOCUS Logo
Docs navigation
On this page

    5.3 Recency

    The recency metadata object and its contents provide information about how up-to-date FOCUS datasets are and when they have been updated.

    5.3.1 Requirements

    Recency adheres to the following requirements:

    • Recency MAY be present in the Metadata.
    • Recency MUST be structured as a collection of objects.
    • Recency MUST NOT be null.
    • Recency collection MUST NOT contain null objects.
    • Recency collection MAY contain one and only one object for every DatasetInstance object.
    • Recency collection object MUST be associated with one and only one DatasetInstance object.
    • Recency collection object MUST be retrievable without inspection of the contents of dataset instance artifacts.
    • Recency collection object SHOULD be updated when the data generator updates the corresponding dataset instance artifact.

    5.3.2 Metadata ID

    Recency

    5.3.3 Metadata Name

    Recency

    5.3.4 Examples

    Example scenarios include but are not limited to:

    For an example of the FOCUS recency metadata, please refer to: Recency Metadata Example.

    5.3.5 Introduced (version)

    1.3

    5.3.6 Dataset Instance ID

    The Dataset Instance ID provides the reference item to associate which Dataset Instance the recency metadata is for.

    DatasetInstanceId adheres to the following requirements:

    • DatasetInstanceId MUST be present in an object within the Recency collection.
    • DatasetInstanceId MUST be of type String.
    • DatasetInstanceId MUST NOT be null.
    • DatasetInstanceId SHOULD be a Globally Unique Identifier (GUID).

    5.3.6.1 Metadata ID

    DatasetInstanceId

    5.3.6.2 Metadata Name

    Dataset Instance ID

    5.3.6.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type String
    Value format GUID (recommended)

    5.3.6.4 Introduced (version)

    1.3

    5.3.7 Dataset Instance Complete

    Dataset Instance Complete provides a boolean value to indicate that the dataset instance is considered complete by the Data Generator. The definition of complete is determined by the Data Generator and should be provided in documentation provided by the Data Generator. For Datasets that are time series, the Complete value indicates that the time sector is complete and therefore is located in as key value in a time sector. For datasets that are not time series, a value of "true" indicates that the dataset is complete and therefore is a property of the recency object.

    DatasetInstanceComplete adheres to the following requirements:

    • DatasetInstanceComplete MUST be present in an object within the Recency collection when the dataset instance is not a time-series dataset.
    • DatasetInstanceComplete MUST be of type Boolean.
    • DatasetInstanceComplete MUST NOT be null.

    5.3.7.1 Metadata ID

    DatasetInstanceComplete

    5.3.7.2 Metadata Name

    Dataset Instance Complete

    5.3.7.3 Content constraints

    Constraint Value
    Feature level Conditional
    Allows nulls False
    Data type Boolean
    Value format <not specified>

    5.3.7.4 Introduced (version)

    1.3

    5.3.8 Dataset Instance Last Updated

    Datetime when the data present in the Dataset Instance was updated.

    DatasetInstanceLastUpdated adheres to the following requirements:

    • DatasetInstanceLastUpdated MUST be present in an object within the Recency collection.
    • DatasetInstanceLastUpdated MUST be of type Date/Time.
    • DatasetInstanceLastUpdated MUST conform to DateTimeFormat requirements.
    • DatasetInstanceLastUpdated MUST NOT be null.

    5.3.8.1 Metadata ID

    DatasetInstanceLastUpdated

    5.3.8.2 Metadata Name

    Dataset Instance Last Updated

    5.3.8.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Date/Time
    Value format Date/Time Format

    5.3.8.4 Introduced (version)

    1.3

    5.3.9 Recency Last Updated

    Datetime the recency metadata object was updated.

    RecencyLastUpdated adheres to the following requirements:

    • RecencyLastUpdated MUST be present in the metadata.
    • RecencyLastUpdated MUST be of type Date/Time.
    • RecencyLastUpdated MUST NOT be null.
    • RecencyLastUpdated MUST conform to DateTimeFormat.

    5.3.9.1 Metadata ID

    RecencyLastUpdated

    5.3.9.2 Metadata Name

    Recency Last Updated

    5.3.9.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Date/Time
    Value format Date/Time Format

    5.3.9.4 Introduced (version)

    1.3

    5.3.10 Time Sectors

    The FOCUS recency metadata's Time Sectors provide a list of time periods and metadata about them. Time Sectors are used when the associated FOCUS dataset is defined as a time series dataset (i.e., its dataset artifacts represent data distributed over time). Each time sector represents a single time period and the completeness of that time period as it pertains to the dataset artifact. Time sectors do not represent start and end dates of the dataset artifact but rather periods of time relative to the datasets Charge Period Start and Charge Period End. Length of time sectors can be determined by the Data Generator, though it is suggested to align time sector periods to the reports time granularity (Hourly cost reports = hourly time sectors).

    5.3.10.1 Requirements

    TimeSectors adheres to the following requirements:

    • TimeSectors MUST be present in an object within the Recency collection when the associated FOCUS dataset is defined as a time series dataset.
    • TimeSectors MUST be structured as a collection of objects.
    • TimeSectors MUST NOT be null.
    • TimeSectors collection MUST contain at least one object.
    • TimeSectors collection MUST NOT contain null objects.
    • TimeSectors collection object MUST be updated, if already present, or added to the collection whenever the data generator updates or provides new dataset artifacts.

    5.3.10.2 Metadata ID

    TimeSectors

    5.3.10.3 Metadata Name

    Time Sectors

    5.3.10.4 Introduced (version)

    1.3

    5.3.10.5 Time Sector Complete

    Time Sector Complete provides a boolean value to indicate that the time sector is considered complete by the DataGenerator. The definition of complete is determined by the DataGenerator and should be provided in documentation provided by the DataGenerator.

    TimeSectorComplete adheres to the following requirements:

    • TimeSectorComplete MUST be present in the TimeSectors subsection of the Recency metadata section.
    • TimeSectorComplete MUST be of type Boolean.
    • TimeSectorComplete MUST not be null.

    5.3.10.5.1 Metadata ID

    TimeSectorComplete

    5.3.10.5.2 Metadata Name

    Time Sector Complete

    5.3.10.5.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Boolean
    Value format <not specified>

    5.3.10.5.4 Introduced (version)

    1.3

    5.3.10.6 Time Sector Last Updated

    Datetime the data in the time sector was last updated.

    TimeSectorLastUpdated adheres to the following requirements:

    • TimeSectorLastUpdated MUST be present in TimeSectors subsection of the Recency metadata section.
    • TimeSectorLastUpdated MUST be of type Date/Time.
    • TimeSectorLastUpdated MUST NOT be null.
    • TimeSectorLastUpdated MUST conform to DateTimeFormat.

    5.3.10.6.1 Metadata ID

    TimeSectorLastUpdated

    5.3.10.6.2 Metadata Name

    Time Sector Last Updated

    5.3.10.6.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Date/Time
    Value format Date/Time Format

    5.3.10.6.4 Introduced (version)

    1.3

    5.3.10.7 Time Sector Start

    The Time Sector Start is the datetime of the start of the time sector.

    TimeSectorStart adheres to the following requirements:

    • TimeSectorStart MUST be present in the TimeSectors subsection of the Recency metadata section.
    • TimeSectorStart MUST be of type Date/Time.
    • TimeSectorStart MUST NOT be null.
    • TimeSectorStart MUST conform to DateTimeFormat.

    5.3.10.7.1 Metadata ID

    TimeSectorStart

    5.3.10.7.2 Metadata Name

    Time Sector Start

    5.3.10.7.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Date/Time
    Value format Date/Time Format

    5.3.10.7.4 Introduced (version)

    1.3

    5.3.10.8 Time Sector End

    The Time Sector End is the datetime of the end of the time sector. The EndTime MUST be later than the StartTime.

    TimeSectorEnd adheres to the following requirements:

    • TimeSectorEnd MUST be present in the TimeSectors subsection of the Recency metadata section.
    • TimeSectorEnd MUST be of type Date/Time.
    • TimeSectorEnd MUST NOT be null.
    • TimeSectorEnd MUST conform to DateTimeFormat.
    • TimeSectorEnd must be exclusive of the end time of the subsequent time sector.
    • TimeSectorEnd MUST be later than TimeSectorStart.

    5.3.10.8.1 Metadata ID

    TimeSectorEnd

    5.3.10.8.2 Metadata Name

    Time Sector End

    5.3.10.8.3 Content constraints

    Constraint Value
    Feature level Mandatory
    Allows nulls False
    Data type Date/Time
    Value format Date/Time Format

    5.3.10.8.4 Introduced (version)

    1.3

    Previous Unit Format Next Data Generator