Record Class PushOptions

java.lang.Object
java.lang.Record
codes.grow.packages.loki.PushOptions
Record Components:
format - wire format (default PushFormat.JSON)
gzip - gzip a JSON body (Content-Encoding: gzip); protobuf bodies are always Snappy-compressed and ignore it

public record PushOptions(PushFormat format, boolean gzip) extends Record
  • Constructor Details

    • PushOptions

      public PushOptions(PushFormat format, boolean gzip)
      Validates the fields.
      Parameters:
      format - wire format, null for JSON
      gzip - whether to gzip JSON bodies
  • Method Details

    • defaults

      public static PushOptions defaults()
      Uncompressed JSON.
      Returns:
      default options
    • of

      public static PushOptions of(PushFormat format)
      Options with a wire format.
      Parameters:
      format - wire format
      Returns:
      the options
    • withGzip

      public PushOptions withGzip(boolean enabled)
      A copy with gzip enabled or disabled.
      Parameters:
      enabled - whether to gzip JSON bodies
      Returns:
      the options
    • 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.
    • format

      public PushFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component
    • gzip

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