Package org.apache.polaris.docs.generator

Record Class StorageAccessPropertyInfo

java.lang.Object
java.lang.Record
org.apache.polaris.docs.generator.StorageAccessPropertyInfo
public record StorageAccessPropertyInfo(String propertyName, String description, String valueType, boolean isCredential, String storageType, String suffixLabel) extends Record
Holds information about a StorageAccessProperty enum constant.

When suffixLabel is non-null the property is a prefix property: the actual runtime key is propertyName + "." + runtimeSuffix, and suffixLabel names what that suffix represents (e.g. "account-host").

  • Constructor Details

    • StorageAccessPropertyInfo

      public StorageAccessPropertyInfo(String propertyName, String description, String valueType, boolean isCredential, String storageType, String suffixLabel)
      Creates an instance of a StorageAccessPropertyInfo record class.
      Parameters:
      propertyName - the value for the propertyName record component
      description - the value for the description record component
      valueType - the value for the valueType record component
      isCredential - the value for the isCredential record component
      storageType - the value for the storageType record component
      suffixLabel - the value for the suffixLabel record component

  • Method Details

    • isPrefixProperty

      public boolean isPrefixProperty()

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

    • propertyName

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

    • description

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

    • valueType

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

    • isCredential

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

    • storageType

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

    • suffixLabel

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