Package com.inductiveautomation.historian.gateway.api

Record Class HistorianProvider

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.HistorianProvider
All Implemented Interfaces:
ExtensionPointProfileConfig
public record HistorianProvider(String type) extends Record implements ExtensionPointProfileConfig
Represents a provider for historian functionality within the gateway.

This class implements the ExtensionPointProfileConfig interface and provides the type of the historian provider. It is used to configure and manage historian-related extension points in the gateway.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HistorianProvider(String type)
    Creates an instance of a HistorianProvider record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • HistorianProvider

      public HistorianProvider(String type)
      Creates an instance of a HistorianProvider record class.
      Parameters:
      type - the value for the type 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.

    • type

      public String type()
      Returns the value of the type record component.
      Specified by:
      type in interface ExtensionPointProfileConfig
      Returns:
      the value of the type record component