Record Class AiProviderAvailability

java.lang.Object
java.lang.Record
com.shaft.pilot.ai.AiProviderAvailability
Record Components:
available - whether the provider has enough configuration to execute
reason - safe reason that never contains credential values
public record AiProviderAvailability(boolean available, String reason) extends Record
Safe provider availability result.

  • Constructor Details

    • AiProviderAvailability

      public AiProviderAvailability(boolean available, String reason)
      Creates an instance of a AiProviderAvailability record class.
      Parameters:
      available - the value for the available record component
      reason - the value for the reason record component

  • Method Details

    • ready

      public static AiProviderAvailability ready()
      Creates an available result.
      Returns:
      available result

    • unavailable

      public static AiProviderAvailability unavailable(String reason)
      Creates an unavailable result.
      Parameters:
      reason - safe unavailability reason
      Returns:
      unavailable result

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • available

      public boolean available()
      Returns the value of the available record component.
      Returns:
      the value of the available record component

    • reason

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