THE LINUX FOUNDATION PROJECTS
Docs navigation
On this page

    5.2 Dataset Instance

    The Dataset Instance metadata object provides information about the dataset instance and its content. Dataset Instance is a data generator-delivered instance of a FOCUS Dataset. For example, a Data Generator may provide multiple datasets utilizing the FOCUS specification, including multiple instances of the FOCUS Cost and Usage dataset, each representing a different time granularity.

    5.2.1 Requirements

    DatasetInstance adheres to the following requirements:

    • DatasetInstance MUST be present in the Metadata.
    • DatasetInstance MUST be structured as a collection of objects.
    • DatasetInstance MUST NOT be null.
    • DatasetInstance collection MUST contain at least one object for every FOCUS dataset supported by the data generator.
    • DatasetInstance collection object MUST NOT be null.
    • DatasetInstance collection object MUST be associated with one and only one FOCUS dataset.

    5.2.2 Metadata ID

    DatasetInstance

    5.2.3 Metadata Name

    Dataset Instance

    5.2.4 Examples

    For an example of the FOCUS dataset instance metadata, please refer to: Dataset Instance Metadata Example.

    5.2.5 Version Introduced

    1.3

    5.2.6 Dataset Instance ID

    The Dataset Instance ID is a data generator-specified unique identifier that represents a specific FOCUS dataset instance provided by the data generator.

    DatasetInstanceId adheres to the following requirements:

    • DatasetInstanceId MUST be present in an object within the DatasetInstance collection.
    • DatasetInstanceId MUST be of type String.
    • DatasetInstanceId MUST NOT contain null values.
    • DatasetInstanceId MUST be a unique identifier within a data generator.
    • DatasetInstanceId SHOULD be a Globally Unique Identifier (GUID).

    5.2.6.1 Metadata ID

    DatasetInstanceId

    5.2.6.2 Metadata Name

    Dataset Instance ID

    5.2.6.3 Content Constraints

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

    5.2.6.4 Version Introduced

    1.3

    5.2.7 Dataset Instance Name

    The human-readable name of the dataset instance as provided by the data generator.

    DatasetInstanceName adheres to the following requirements:

    • DatasetInstanceName MUST be present in an object within the DatasetInstance collection.
    • DatasetInstanceName MUST be of type String.
    • DatasetInstanceName MUST NOT be null.

    5.2.7.1 Metadata ID

    DatasetInstanceName

    5.2.7.2 Metadata Name

    Dataset Instance Name

    5.2.7.3 Content Constraints

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

    5.2.7.4 Version Introduced

    1.3

    5.2.8 FOCUS Dataset ID

    The identifier of the FOCUS dataset for which the schema and its data conform to. This indicates which FOCUS dataset the data artifact aligns with, such as "FOCUS Cost and Usage" or "FOCUS Contract."

    The FocusDatasetId property adheres to the following requirements:

    • FocusDatasetId MUST be present in an object within the DatasetInstance collection.
    • FocusDatasetId MUST be of type String.
    • FocusDatasetId MUST NOT be null.
    • FocusDatasetId MUST match the Dataset ID of one of the FOCUS datasets defined in the FOCUS specification.

    5.2.8.1 Metadata ID

    FocusDatasetId

    5.2.8.2 Metadata Name

    FOCUS Dataset ID

    5.2.8.3 Content Constraints

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

    5.2.8.4 Version Introduced

    1.3