Record Class AegisConfig

java.lang.Object
java.lang.Record
com.cockroachlabs.crdb.spi.AegisConfig
Record Components:
enabled - whether Aegis integration is enabled
endpoint - the Aegis API endpoint; null/blank selects the simulated in-memory backend
token - bearer token for the Aegis API (may be null)
public record AegisConfig(boolean enabled, String endpoint, String token) extends Record
Configuration for the Cockroach Aegis client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AegisConfig(boolean enabled, String endpoint, String token)
    Creates an instance of a AegisConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AegisConfig
    defaults()
    Disabled by default: selects the simulated backend, emits nothing remote.
    boolean
    enabled()
    Returns the value of the enabled record component.
    String
    endpoint()
    Returns the value of the endpoint record component.
    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.
    String
    token()
    Returns the value of the token record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    useSimulated()
    Whether the simulated backend should be used (disabled or no endpoint).

    Methods inherited from class Object

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

  • Constructor Details

    • AegisConfig

      public AegisConfig(boolean enabled, String endpoint, String token)
      Creates an instance of a AegisConfig record class.
      Parameters:
      enabled - the value for the enabled record component
      endpoint - the value for the endpoint record component
      token - the value for the token record component

  • Method Details

    • defaults

      public static AegisConfig defaults()
      Disabled by default: selects the simulated backend, emits nothing remote.

    • useSimulated

      public boolean useSimulated()
      Whether the simulated backend should be used (disabled or no endpoint).

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

    • enabled

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

    • endpoint

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

    • token

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