Package com.linkedin.venice.pubsub.api

Class PubSubMessageHeaders

java.lang.Object

com.linkedin.venice.pubsub.api.PubSubMessageHeaders

All Implemented Interfaces:

Measurable, Iterable<PubSubMessageHeader>

Direct Known Subclasses:

EmptyPubSubMessageHeaders

public class PubSubMessageHeaders
extends Object
implements Measurable, Iterable<PubSubMessageHeader>

Set of key-value pairs to tagged with messages produced to a topic. In case of headers with the same key, only the most recently added headers value will be kept.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VENICE_LEADER_COMPLETION_STATE_HEADER	Header to denote whether the leader is completed or not
static final String	VENICE_TRANSPORT_PROTOCOL_HEADER

Constructor Summary

Constructors

Constructor	Description
PubSubMessageHeaders()

Method Summary

Modifier and Type	Method	Description
PubSubMessageHeaders	add(PubSubMessageHeader header)
PubSubMessageHeaders	add(String key, byte[] value)
int	getHeapSize()
boolean	isEmpty()
Iterator<PubSubMessageHeader>	iterator()
PubSubMessageHeaders	remove(String key)
List<PubSubMessageHeader>	toList()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

VENICE_TRANSPORT_PROTOCOL_HEADER

public static final String VENICE_TRANSPORT_PROTOCOL_HEADER

See Also:

• Constant Field Values

VENICE_LEADER_COMPLETION_STATE_HEADER

public static final String VENICE_LEADER_COMPLETION_STATE_HEADER

Header to denote whether the leader is completed or not

See Also:

• Constant Field Values

Constructor Details

PubSubMessageHeaders

public PubSubMessageHeaders()

Method Details

add

public PubSubMessageHeaders add(PubSubMessageHeader header)

add

public PubSubMessageHeaders add(String key,
 byte[] value)

remove

public PubSubMessageHeaders remove(String key)

toList

public List<PubSubMessageHeader> toList()

Returns:

the headers as a List. Mutating this list will not affect the PubSubMessageHeaders. If no headers are present an empty list is returned.

isEmpty

public boolean isEmpty()

getHeapSize

public int getHeapSize()

Specified by:

getHeapSize in interface Measurable

iterator

public Iterator<PubSubMessageHeader> iterator()

Specified by:

iterator in interface Iterable<PubSubMessageHeader>