Class EntityResponse

  • All Implemented Interfaces:
    java.io.Externalizable , java.io.Serializable , java.lang.Comparable , org.apache.avro.generic.GenericContainer , org.apache.avro.generic.GenericRecord , org.apache.avro.generic.IndexedRecord , org.apache.avro.specific.SpecificRecord

    
    public class EntityResponse
    extends SpecificRecordBase implements SpecificRecord
                        

    The response to an EntityRequest.

    • Constructor Detail

      • EntityResponse

        EntityResponse()
        Default constructor.
      • EntityResponse

        EntityResponse(List<ByteBuffer> results, KeyValuePairList metadata, ByteBuffer resumePoint)
        All-args constructor.
        Parameters:
        results - Result of request, as a list of AMQP-formatted user defined objects, which may be empty or have 1 element for certain persistence operations
        metadata - Metadata returned from the execution of the persistence operation
        resumePoint - Used by queries that support stable paging to return opaque data that indicates where the next page should resume from
    • Method Detail

      • getResults

         List<ByteBuffer> getResults()

        Gets the value of the 'results' field.

        Returns:

        Result of request, as a list of AMQP-formatted user defined objects, which may be empty or have 1 element for certain persistence operations

      • setResults

         void setResults(List<ByteBuffer> value)

        Sets the value of the 'results' field. Result of request, as a list of AMQP-formatted user defined objects, which may be empty or have 1 element for certain persistence operations

        Parameters:
        value - the value to set.
      • getMetadata

         KeyValuePairList getMetadata()

        Gets the value of the 'metadata' field.

        Returns:

        Metadata returned from the execution of the persistence operation

      • setMetadata

         void setMetadata(KeyValuePairList value)

        Sets the value of the 'metadata' field. Metadata returned from the execution of the persistence operation

        Parameters:
        value - the value to set.
      • getResumePoint

         ByteBuffer getResumePoint()

        Gets the value of the 'resumePoint' field.

        Returns:

        Used by queries that support stable paging to return opaque data that indicates where the next page should resume from

      • setResumePoint

         void setResumePoint(ByteBuffer value)

        Sets the value of the 'resumePoint' field. Used by queries that support stable paging to return opaque data that indicates where the next page should resume from

        Parameters:
        value - the value to set.
      • getEncoder

         static BinaryMessageEncoder<EntityResponse> getEncoder()

        Return the BinaryMessageEncoder instance used by this class.

        Returns:

        the message encoder used by this class

      • getDecoder

         static BinaryMessageDecoder<EntityResponse> getDecoder()

        Return the BinaryMessageDecoder instance used by this class.

        Returns:

        the message decoder used by this class

      • createDecoder

         static BinaryMessageDecoder<EntityResponse> createDecoder(SchemaStore resolver)

        Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.

        Parameters:
        resolver - a SchemaStore used to find schemas by fingerprint
        Returns:

        a BinaryMessageDecoder instance for this class backed by the given SchemaStore

      • toByteBuffer

         ByteBuffer toByteBuffer()

        Serializes this EntityResponse to a ByteBuffer.

        Returns:

        a buffer holding the serialized data for this instance

      • fromByteBuffer

         static EntityResponse fromByteBuffer(ByteBuffer b)

        Deserializes a EntityResponse from a ByteBuffer.

        Parameters:
        b - a byte buffer holding serialized data for an instance of this class
        Returns:

        a EntityResponse instance decoded from the given buffer

      • newBuilder

         static EntityResponse.Builder newBuilder(EntityResponse other)

        Creates a new EntityResponse RecordBuilder by copying an existing EntityResponse instance.

        Parameters:
        other - The existing instance to copy.
        Returns:

        A new EntityResponse RecordBuilder