Package energy.eddie.api.v0

Interface RegionConnectorMetadata

All Known Implementing Classes:
AiidaRegionConnectorMetadata, CdsRegionConnectorMetadata, DatadisRegionConnectorMetadata, EdaRegionConnectorMetadata, EnedisRegionConnectorMetadata, EnerginetRegionConnectorMetadata, EtaRegionConnectorMetadata, FingridRegionConnectorMetadata, FluviusRegionConnectorMetadata, GreenButtonRegionConnectorMetadata, MijnAansluitingRegionConnectorMetadata, MojElektroRegionConnectorMetadata, SimulationConnectorMetadata
public interface RegionConnectorMetadata
Metadata for a RegionConnector.

  • Method Details

    • id

      String id()
      A unique identifier of a RegionConnector.

    • countryCodes

      default List<String> countryCodes()
      Country codes of the regions covered by a RegionConnector. Must be uppercase. Defaults to a single country code.

    • countryCode

      String countryCode()
      Country code of the region covered by a RegionConnector. Must be uppercase.

    • coveredMeteringPoints

      long coveredMeteringPoints()
      Number of metering points that are accessible through a RegionConnector.

    • earliestStart

      Period earliestStart()
      The earliest possible start for a region-connector.

    • latestEnd

      Period latestEnd()
      The latest possible end for a region-connector.

    • supportedGranularities

      List<Granularity> supportedGranularities()
      List of supported granularities.

    • timeZone

      ZoneId timeZone()

    • supportedEnergyTypes

      List<EnergyType> supportedEnergyTypes()
      The energy types for which the region connector can request validated historical data.
      Returns:
      the supported energy types

    • granularitiesFor

      default List<Granularity> granularitiesFor(EnergyType energyType)
      Returns the supported granularities for one energy type.
      Parameters:
      energyType - the energy type
      Returns:
      the granularities in which the validated historical data is available for that energy type

    • supportedDataNeeds

      List<Class<? extends DataNeedInterface>> supportedDataNeeds()
      List of supported Data Needs