Package com.coveo.pushapiclient

Record Class CompressedBinaryData

java.lang.Object
java.lang.Record
com.coveo.pushapiclient.CompressedBinaryData
Record Components:
data - The base64 encoded binary data. Example: `eJxzrUjMLchJBQAK4ALN`
compressionType - The compression type that was applied to your document.
public record CompressedBinaryData(String data, CompressionType compressionType) extends Record
The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.

You can use this parameter when you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is less than 5 MB.

Whenever you're pushing an item whose size is 5 MB or more, use the CompressedBinaryDataFileIdproperty instead.

If you're pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.

See https://docs.coveo.com/en/73 for more information.

  • Constructor Details

    • CompressedBinaryData

      public CompressedBinaryData​(String data, CompressionType compressionType)
      Creates an instance of a CompressedBinaryData record class.
      Parameters:
      data - the value for the data record component
      compressionType - the value for the compressionType record component

  • Method Details

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

    • data

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

    • compressionType

      public CompressionType compressionType()
      Returns the value of the compressionType record component.
      Returns:
      the value of the compressionType record component