Package com.linkedin.venice.read.protocol.response.streaming

Class StreamingFooterRecordV1

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
    public class StreamingFooterRecordV1
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord
    This record will store all the additional info after sending out streaming response
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.nio.ByteBuffer detail
      Error detail
      static org.apache.avro.Schema SCHEMA$  
      int status
      Final HTTP status code (non-200) after processing the streaming request completely
      java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> trailerHeaders
      Additional headers after sending out response headers

    • Constructor Summary

      Constructors 
      Constructor Description
      StreamingFooterRecordV1()
      Default constructor.
      StreamingFooterRecordV1​(java.lang.Integer status, java.nio.ByteBuffer detail, java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> trailerHeaders)
      All-args constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object get​(int field$)  
      static org.apache.avro.Schema getClassSchema()  
      java.nio.ByteBuffer getDetail()
      Gets the value of the 'detail' field.
      org.apache.avro.Schema getSchema()  
      org.apache.avro.specific.SpecificData getSpecificData()  
      int getStatus()
      Gets the value of the 'status' field.
      java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> getTrailerHeaders()
      Gets the value of the 'trailerHeaders' field.
      void put​(int field$, java.lang.Object value$)  
      void readExternal​(java.io.ObjectInput in)  
      void setDetail​(java.nio.ByteBuffer value)
      Sets the value of the 'detail' field.
      void setStatus​(int value)
      Sets the value of the 'status' field.
      void setTrailerHeaders​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> value)
      Sets the value of the 'trailerHeaders' field.
      void writeExternal​(java.io.ObjectOutput out)  

      • Methods inherited from class org.apache.avro.specific.SpecificRecordBase

        compareTo, customDecode, customEncode, equals, get, getConversion, getConversion, hasCustomCoders, hashCode, put, toString

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apache.avro.generic.GenericRecord

        hasField

    • Field Detail

      • SCHEMA$

        public static final org.apache.avro.Schema SCHEMA$

      • status

        public int status
        Final HTTP status code (non-200) after processing the streaming request completely

      • detail

        public java.nio.ByteBuffer detail
        Error detail

      • trailerHeaders

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> trailerHeaders
        Additional headers after sending out response headers

    • Constructor Detail

      • StreamingFooterRecordV1

        public StreamingFooterRecordV1()
        Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should use newBuilder().

      • StreamingFooterRecordV1

        public StreamingFooterRecordV1​(java.lang.Integer status,
                               java.nio.ByteBuffer detail,
                               java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> trailerHeaders)
        All-args constructor.
        Parameters:
        status - Final HTTP status code (non-200) after processing the streaming request completely
        detail - Error detail
        trailerHeaders - Additional headers after sending out response headers

    • Method Detail

      • getClassSchema

        public static org.apache.avro.Schema getClassSchema()

      • getSpecificData

        public org.apache.avro.specific.SpecificData getSpecificData()
        Overrides:
        getSpecificData in class org.apache.avro.specific.SpecificRecordBase

      • getSchema

        public org.apache.avro.Schema getSchema()
        Specified by:
        getSchema in interface org.apache.avro.generic.GenericContainer
        Specified by:
        getSchema in class org.apache.avro.specific.SpecificRecordBase

      • get

        public java.lang.Object get​(int field$)
        Specified by:
        get in interface org.apache.avro.generic.IndexedRecord
        Specified by:
        get in class org.apache.avro.specific.SpecificRecordBase

      • put

        public void put​(int field$,
                java.lang.Object value$)
        Specified by:
        put in interface org.apache.avro.generic.IndexedRecord
        Specified by:
        put in class org.apache.avro.specific.SpecificRecordBase

      • getStatus

        public int getStatus()
        Gets the value of the 'status' field.
        Returns:
        Final HTTP status code (non-200) after processing the streaming request completely

      • setStatus

        public void setStatus​(int value)
        Sets the value of the 'status' field. Final HTTP status code (non-200) after processing the streaming request completely
        Parameters:
        value - the value to set.

      • getDetail

        public java.nio.ByteBuffer getDetail()
        Gets the value of the 'detail' field.
        Returns:
        Error detail

      • setDetail

        public void setDetail​(java.nio.ByteBuffer value)
        Sets the value of the 'detail' field. Error detail
        Parameters:
        value - the value to set.

      • getTrailerHeaders

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> getTrailerHeaders()
        Gets the value of the 'trailerHeaders' field.
        Returns:
        Additional headers after sending out response headers

      • setTrailerHeaders

        public void setTrailerHeaders​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> value)
        Sets the value of the 'trailerHeaders' field. Additional headers after sending out response headers
        Parameters:
        value - the value to set.

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class org.apache.avro.specific.SpecificRecordBase
        Throws:
        java.io.IOException

      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                  throws java.io.IOException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class org.apache.avro.specific.SpecificRecordBase
        Throws:
        java.io.IOException