Package org.graylog2.bootstrap.preflight.web.resources

Record Class ConnectionCheckResult

java.lang.Object
java.lang.Record
org.graylog2.bootstrap.preflight.web.resources.ConnectionCheckResult
public record ConnectionCheckResult(@Nullable SearchVersion searchVersion, String errorMessage) extends Record

  • Constructor Details

    • ConnectionCheckResult

      public ConnectionCheckResult(@Nullable SearchVersion searchVersion, String errorMessage)
      Creates an instance of a ConnectionCheckResult record class.
      Parameters:
      searchVersion - the value for the searchVersion record component
      errorMessage - the value for the errorMessage record component

  • Method Details

    • success

      public static ConnectionCheckResult success(SearchVersion searchVersion)

    • failure

      public static ConnectionCheckResult failure(String error)

    • succeeded

      public boolean succeeded()

    • 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.

    • searchVersion

      @Nullable public SearchVersion searchVersion()
      Returns the value of the searchVersion record component.
      Returns:
      the value of the searchVersion record component

    • errorMessage

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