Package com.linkedin.venice.status.protocol

Class PushJobDetails

  • 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 PushJobDetails
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord
    See Also:
    Serialized Form

    • Field Detail

      • SCHEMA$

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

      • clusterName

        public java.lang.CharSequence clusterName

      • reportTimestamp

        public long reportTimestamp
        timestamp for when the reported details were collected

      • pushId

        public java.lang.CharSequence pushId

      • partitionCount

        public int partitionCount

      • valueCompressionStrategy

        public int valueCompressionStrategy
        0 => NO_OP, 1 => GZIP

      • chunkingEnabled

        public boolean chunkingEnabled

      • jobDurationInMs

        public long jobDurationInMs

      • totalNumberOfRecords

        public long totalNumberOfRecords
        total number of key value pairs pushed

      • totalKeyBytes

        public long totalKeyBytes
        total amount of key bytes pushed

      • totalRawValueBytes

        public long totalRawValueBytes
        total amount of uncompressed value bytes

      • totalCompressedValueBytes

        public long totalCompressedValueBytes
        total amount of compressed value bytes stored

      • totalGzipCompressedValueBytes

        public long totalGzipCompressedValueBytes
        total amount of Gzip compressed value bytes

      • totalZstdWithDictCompressedValueBytes

        public long totalZstdWithDictCompressedValueBytes
        total amount of Zstd with Dictionary compressed value bytes

      • pushJobConfigs

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> pushJobConfigs

      • producerConfigs

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> producerConfigs

      • pushJobLatestCheckpoint

        public java.lang.Integer pushJobLatestCheckpoint
        Latest checkpoint reached by the push job if available, negative values are known error checkpoints. Refer to VenicePushJob.PushJobCheckpoints

      • failureDetails

        public java.lang.CharSequence failureDetails

      • sendLivenessHeartbeatFailureDetails

        public java.lang.CharSequence sendLivenessHeartbeatFailureDetails
        Failure details of sending liveness heartbeat from the push job. If no failure or the job is not enabled to send liveness heartbeat, this field is null

    • Constructor Detail

      • PushJobDetails

        public PushJobDetails()
        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().

      • PushJobDetails

        public PushJobDetails​(java.lang.CharSequence clusterName,
                      java.lang.Long reportTimestamp,
                      java.util.List<PushJobDetailsStatusTuple> overallStatus,
                      java.util.Map<java.lang.CharSequence,​java.util.List<PushJobDetailsStatusTuple>> coloStatus,
                      java.lang.CharSequence pushId,
                      java.lang.Integer partitionCount,
                      java.lang.Integer valueCompressionStrategy,
                      java.lang.Boolean chunkingEnabled,
                      java.lang.Long jobDurationInMs,
                      java.lang.Long totalNumberOfRecords,
                      java.lang.Long totalKeyBytes,
                      java.lang.Long totalRawValueBytes,
                      java.lang.Long totalCompressedValueBytes,
                      java.lang.Long totalGzipCompressedValueBytes,
                      java.lang.Long totalZstdWithDictCompressedValueBytes,
                      java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> pushJobConfigs,
                      java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> producerConfigs,
                      java.lang.Integer pushJobLatestCheckpoint,
                      java.lang.CharSequence failureDetails,
                      java.lang.CharSequence sendLivenessHeartbeatFailureDetails)
        All-args constructor.
        Parameters:
        clusterName - The new value for clusterName
        reportTimestamp - timestamp for when the reported details were collected
        overallStatus - The new value for overallStatus
        coloStatus - The new value for coloStatus
        pushId - The new value for pushId
        partitionCount - The new value for partitionCount
        valueCompressionStrategy - 0 => NO_OP, 1 => GZIP
        chunkingEnabled - The new value for chunkingEnabled
        jobDurationInMs - The new value for jobDurationInMs
        totalNumberOfRecords - total number of key value pairs pushed
        totalKeyBytes - total amount of key bytes pushed
        totalRawValueBytes - total amount of uncompressed value bytes
        totalCompressedValueBytes - total amount of compressed value bytes stored
        totalGzipCompressedValueBytes - total amount of Gzip compressed value bytes
        totalZstdWithDictCompressedValueBytes - total amount of Zstd with Dictionary compressed value bytes
        pushJobConfigs - The new value for pushJobConfigs
        producerConfigs - The new value for producerConfigs
        pushJobLatestCheckpoint - Latest checkpoint reached by the push job if available, negative values are known error checkpoints. Refer to VenicePushJob.PushJobCheckpoints
        failureDetails - The new value for failureDetails
        sendLivenessHeartbeatFailureDetails - Failure details of sending liveness heartbeat from the push job. If no failure or the job is not enabled to send liveness heartbeat, this field is null

    • 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

      • getClusterName

        public java.lang.CharSequence getClusterName()
        Gets the value of the 'clusterName' field.
        Returns:
        The value of the 'clusterName' field.

      • setClusterName

        public void setClusterName​(java.lang.CharSequence value)
        Sets the value of the 'clusterName' field.
        Parameters:
        value - the value to set.

      • getReportTimestamp

        public long getReportTimestamp()
        Gets the value of the 'reportTimestamp' field.
        Returns:
        timestamp for when the reported details were collected

      • setReportTimestamp

        public void setReportTimestamp​(long value)
        Sets the value of the 'reportTimestamp' field. timestamp for when the reported details were collected
        Parameters:
        value - the value to set.

      • getOverallStatus

        public java.util.List<PushJobDetailsStatusTuple> getOverallStatus()
        Gets the value of the 'overallStatus' field.
        Returns:
        The value of the 'overallStatus' field.

      • setOverallStatus

        public void setOverallStatus​(java.util.List<PushJobDetailsStatusTuple> value)
        Sets the value of the 'overallStatus' field.
        Parameters:
        value - the value to set.

      • getColoStatus

        public java.util.Map<java.lang.CharSequence,​java.util.List<PushJobDetailsStatusTuple>> getColoStatus()
        Gets the value of the 'coloStatus' field.
        Returns:
        The value of the 'coloStatus' field.

      • setColoStatus

        public void setColoStatus​(java.util.Map<java.lang.CharSequence,​java.util.List<PushJobDetailsStatusTuple>> value)
        Sets the value of the 'coloStatus' field.
        Parameters:
        value - the value to set.

      • getPushId

        public java.lang.CharSequence getPushId()
        Gets the value of the 'pushId' field.
        Returns:
        The value of the 'pushId' field.

      • setPushId

        public void setPushId​(java.lang.CharSequence value)
        Sets the value of the 'pushId' field.
        Parameters:
        value - the value to set.

      • getPartitionCount

        public int getPartitionCount()
        Gets the value of the 'partitionCount' field.
        Returns:
        The value of the 'partitionCount' field.

      • setPartitionCount

        public void setPartitionCount​(int value)
        Sets the value of the 'partitionCount' field.
        Parameters:
        value - the value to set.

      • getValueCompressionStrategy

        public int getValueCompressionStrategy()
        Gets the value of the 'valueCompressionStrategy' field.
        Returns:
        0 => NO_OP, 1 => GZIP

      • setValueCompressionStrategy

        public void setValueCompressionStrategy​(int value)
        Sets the value of the 'valueCompressionStrategy' field. 0 => NO_OP, 1 => GZIP
        Parameters:
        value - the value to set.

      • getChunkingEnabled

        public boolean getChunkingEnabled()
        Gets the value of the 'chunkingEnabled' field.
        Returns:
        The value of the 'chunkingEnabled' field.

      • setChunkingEnabled

        public void setChunkingEnabled​(boolean value)
        Sets the value of the 'chunkingEnabled' field.
        Parameters:
        value - the value to set.

      • getJobDurationInMs

        public long getJobDurationInMs()
        Gets the value of the 'jobDurationInMs' field.
        Returns:
        The value of the 'jobDurationInMs' field.

      • setJobDurationInMs

        public void setJobDurationInMs​(long value)
        Sets the value of the 'jobDurationInMs' field.
        Parameters:
        value - the value to set.

      • getTotalNumberOfRecords

        public long getTotalNumberOfRecords()
        Gets the value of the 'totalNumberOfRecords' field.
        Returns:
        total number of key value pairs pushed

      • setTotalNumberOfRecords

        public void setTotalNumberOfRecords​(long value)
        Sets the value of the 'totalNumberOfRecords' field. total number of key value pairs pushed
        Parameters:
        value - the value to set.

      • getTotalKeyBytes

        public long getTotalKeyBytes()
        Gets the value of the 'totalKeyBytes' field.
        Returns:
        total amount of key bytes pushed

      • setTotalKeyBytes

        public void setTotalKeyBytes​(long value)
        Sets the value of the 'totalKeyBytes' field. total amount of key bytes pushed
        Parameters:
        value - the value to set.

      • getTotalRawValueBytes

        public long getTotalRawValueBytes()
        Gets the value of the 'totalRawValueBytes' field.
        Returns:
        total amount of uncompressed value bytes

      • setTotalRawValueBytes

        public void setTotalRawValueBytes​(long value)
        Sets the value of the 'totalRawValueBytes' field. total amount of uncompressed value bytes
        Parameters:
        value - the value to set.

      • getTotalCompressedValueBytes

        public long getTotalCompressedValueBytes()
        Gets the value of the 'totalCompressedValueBytes' field.
        Returns:
        total amount of compressed value bytes stored

      • setTotalCompressedValueBytes

        public void setTotalCompressedValueBytes​(long value)
        Sets the value of the 'totalCompressedValueBytes' field. total amount of compressed value bytes stored
        Parameters:
        value - the value to set.

      • getTotalGzipCompressedValueBytes

        public long getTotalGzipCompressedValueBytes()
        Gets the value of the 'totalGzipCompressedValueBytes' field.
        Returns:
        total amount of Gzip compressed value bytes

      • setTotalGzipCompressedValueBytes

        public void setTotalGzipCompressedValueBytes​(long value)
        Sets the value of the 'totalGzipCompressedValueBytes' field. total amount of Gzip compressed value bytes
        Parameters:
        value - the value to set.

      • getTotalZstdWithDictCompressedValueBytes

        public long getTotalZstdWithDictCompressedValueBytes()
        Gets the value of the 'totalZstdWithDictCompressedValueBytes' field.
        Returns:
        total amount of Zstd with Dictionary compressed value bytes

      • setTotalZstdWithDictCompressedValueBytes

        public void setTotalZstdWithDictCompressedValueBytes​(long value)
        Sets the value of the 'totalZstdWithDictCompressedValueBytes' field. total amount of Zstd with Dictionary compressed value bytes
        Parameters:
        value - the value to set.

      • getPushJobConfigs

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> getPushJobConfigs()
        Gets the value of the 'pushJobConfigs' field.
        Returns:
        The value of the 'pushJobConfigs' field.

      • setPushJobConfigs

        public void setPushJobConfigs​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> value)
        Sets the value of the 'pushJobConfigs' field.
        Parameters:
        value - the value to set.

      • getProducerConfigs

        public java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> getProducerConfigs()
        Gets the value of the 'producerConfigs' field.
        Returns:
        The value of the 'producerConfigs' field.

      • setProducerConfigs

        public void setProducerConfigs​(java.util.Map<java.lang.CharSequence,​java.lang.CharSequence> value)
        Sets the value of the 'producerConfigs' field.
        Parameters:
        value - the value to set.

      • getPushJobLatestCheckpoint

        public java.lang.Integer getPushJobLatestCheckpoint()
        Gets the value of the 'pushJobLatestCheckpoint' field.
        Returns:
        Latest checkpoint reached by the push job if available, negative values are known error checkpoints. Refer to VenicePushJob.PushJobCheckpoints

      • setPushJobLatestCheckpoint

        public void setPushJobLatestCheckpoint​(java.lang.Integer value)
        Sets the value of the 'pushJobLatestCheckpoint' field. Latest checkpoint reached by the push job if available, negative values are known error checkpoints. Refer to VenicePushJob.PushJobCheckpoints
        Parameters:
        value - the value to set.

      • getFailureDetails

        public java.lang.CharSequence getFailureDetails()
        Gets the value of the 'failureDetails' field.
        Returns:
        The value of the 'failureDetails' field.

      • setFailureDetails

        public void setFailureDetails​(java.lang.CharSequence value)
        Sets the value of the 'failureDetails' field.
        Parameters:
        value - the value to set.

      • getSendLivenessHeartbeatFailureDetails

        public java.lang.CharSequence getSendLivenessHeartbeatFailureDetails()
        Gets the value of the 'sendLivenessHeartbeatFailureDetails' field.
        Returns:
        Failure details of sending liveness heartbeat from the push job. If no failure or the job is not enabled to send liveness heartbeat, this field is null

      • setSendLivenessHeartbeatFailureDetails

        public void setSendLivenessHeartbeatFailureDetails​(java.lang.CharSequence value)
        Sets the value of the 'sendLivenessHeartbeatFailureDetails' field. Failure details of sending liveness heartbeat from the push job. If no failure or the job is not enabled to send liveness heartbeat, this field is null
        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