Record Class XPackLicenseStatus

java.lang.Object
java.lang.Record
org.elasticsearch.license.internal.XPackLicenseStatus
Record Components:
mode - The current "mode" of the license (ie license type).
active - True if the license is active, or false if it is expired.
expiryWarning - A warning to be emitted on license checks about the license expiring soon.

public record XPackLicenseStatus(License.OperationMode mode, boolean active, String expiryWarning) extends Record
A wrapper for the license mode, state, and expiration date, to allow atomically swapping.
  • Constructor Details

    • XPackLicenseStatus

      public XPackLicenseStatus(License.OperationMode mode, boolean active, String expiryWarning)
      Creates an instance of a XPackLicenseStatus record class.
      Parameters:
      mode - the value for the mode record component
      active - the value for the active record component
      expiryWarning - the value for the expiryWarning 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • mode

      public License.OperationMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component
    • active

      public boolean active()
      Returns the value of the active record component.
      Returns:
      the value of the active record component
    • expiryWarning

      public String expiryWarning()
      Returns the value of the expiryWarning record component.
      Returns:
      the value of the expiryWarning record component