Package energy.eddie.regionconnector.fr.enedis.dto.subscription

Record Class SubscribedService

java.lang.Object
java.lang.Record
energy.eddie.regionconnector.fr.enedis.dto.subscription.SubscribedService
Record Components:
id - Identifier of the subscribed service.
injection - True if the service concerns production (injection) data.
consumption - True if the service concerns consumption (withdrawal) data.
serviceType - Code of the service (e.g. ServiceType.ACCES).
start - Start date of the service.
end - End date of the service.
state - State of the service.
stateLabel - Label associated with the state.
pointId - Identifier of the point (the PRM).
holderSiren - SIREN of the point holder.
beneficiarySiren - SIREN of the service beneficiary.
measureType - Type of measurement (CDC, IDX, PMAX, ENERGIE, ITC).
measureStep - Measurement step (PT10M, PT15M, PT30M, P1D, NA).
transmissionPeriodicity - Data publication frequency (P1D, P7D, P1M).
correctedMeasures - Whether the measures are corrected or raw.
dynamicSpace - True if the service is intended for the dynamic space.
dataPublication - True if the service is an access service with a publication option.
authorization - Authorization details associated with the service.
public record SubscribedService(@Nullable String id, @Nullable Boolean injection, @Nullable Boolean consumption, @Nullable ServiceType serviceType, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable ServiceState state, @Nullable String stateLabel, @Nullable String pointId, @Nullable String holderSiren, @Nullable String beneficiarySiren, @Nullable MeasureType measureType, @Nullable String measureStep, @Nullable String transmissionPeriodicity, @Nullable Boolean correctedMeasures, @Nullable Boolean dynamicSpace, @Nullable Boolean dataPublication, @Nullable ServiceAuthorization authorization) extends Record
A single subscribed service as returned by the subscribed services API.

  • Constructor Details

    • SubscribedService

      public SubscribedService(@Nullable String id, @Nullable Boolean injection, @Nullable Boolean consumption, @Nullable ServiceType serviceType, @Nullable LocalDate start, @Nullable LocalDate end, @Nullable ServiceState state, @Nullable String stateLabel, @Nullable String pointId, @Nullable String holderSiren, @Nullable String beneficiarySiren, @Nullable MeasureType measureType, @Nullable String measureStep, @Nullable String transmissionPeriodicity, @Nullable Boolean correctedMeasures, @Nullable Boolean dynamicSpace, @Nullable Boolean dataPublication, @Nullable ServiceAuthorization authorization)
      Creates an instance of a SubscribedService record class.
      Parameters:
      id - the value for the id record component
      injection - the value for the injection record component
      consumption - the value for the consumption record component
      serviceType - the value for the serviceType record component
      start - the value for the start record component
      end - the value for the end record component
      state - the value for the state record component
      stateLabel - the value for the stateLabel record component
      pointId - the value for the pointId record component
      holderSiren - the value for the holderSiren record component
      beneficiarySiren - the value for the beneficiarySiren record component
      measureType - the value for the measureType record component
      measureStep - the value for the measureStep record component
      transmissionPeriodicity - the value for the transmissionPeriodicity record component
      correctedMeasures - the value for the correctedMeasures record component
      dynamicSpace - the value for the dynamicSpace record component
      dataPublication - the value for the dataPublication record component
      authorization - the value for the authorization record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public @Nullable String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • injection

      public @Nullable Boolean injection()
      Returns the value of the injection record component.
      Returns:
      the value of the injection record component

    • consumption

      public @Nullable Boolean consumption()
      Returns the value of the consumption record component.
      Returns:
      the value of the consumption record component

    • serviceType

      public @Nullable ServiceType serviceType()
      Returns the value of the serviceType record component.
      Returns:
      the value of the serviceType record component

    • start

      public @Nullable LocalDate start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public @Nullable LocalDate end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component

    • state

      public @Nullable ServiceState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • stateLabel

      public @Nullable String stateLabel()
      Returns the value of the stateLabel record component.
      Returns:
      the value of the stateLabel record component

    • pointId

      public @Nullable String pointId()
      Returns the value of the pointId record component.
      Returns:
      the value of the pointId record component

    • holderSiren

      public @Nullable String holderSiren()
      Returns the value of the holderSiren record component.
      Returns:
      the value of the holderSiren record component

    • beneficiarySiren

      public @Nullable String beneficiarySiren()
      Returns the value of the beneficiarySiren record component.
      Returns:
      the value of the beneficiarySiren record component

    • measureType

      public @Nullable MeasureType measureType()
      Returns the value of the measureType record component.
      Returns:
      the value of the measureType record component

    • measureStep

      public @Nullable String measureStep()
      Returns the value of the measureStep record component.
      Returns:
      the value of the measureStep record component

    • transmissionPeriodicity

      public @Nullable String transmissionPeriodicity()
      Returns the value of the transmissionPeriodicity record component.
      Returns:
      the value of the transmissionPeriodicity record component

    • correctedMeasures

      public @Nullable Boolean correctedMeasures()
      Returns the value of the correctedMeasures record component.
      Returns:
      the value of the correctedMeasures record component

    • dynamicSpace

      public @Nullable Boolean dynamicSpace()
      Returns the value of the dynamicSpace record component.
      Returns:
      the value of the dynamicSpace record component

    • dataPublication

      public @Nullable Boolean dataPublication()
      Returns the value of the dataPublication record component.
      Returns:
      the value of the dataPublication record component

    • authorization

      public @Nullable ServiceAuthorization authorization()
      Returns the value of the authorization record component.
      Returns:
      the value of the authorization record component