org.apache.hedwig.protocol

Class PubSubProtocol.SubscriptionOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.hedwig.protocol.PubSubProtocol.SubscriptionOptions

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, PubSubProtocol.SubscriptionOptionsOrBuilder

Enclosing class:

PubSubProtocol

public static final class PubSubProtocol.SubscriptionOptions
extends com.google.protobuf.GeneratedMessageV3
implements PubSubProtocol.SubscriptionOptionsOrBuilder

 used in client only
 options are stored in SubscriptionPreferences structure
 

Protobuf type Hedwig.SubscriptionOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubProtocol.SubscriptionOptions.Builder used in client only options are stored in SubscriptionPreferences structure

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATEORATTACH_FIELD_NUMBER
static int	ENABLERESUBSCRIBE_FIELD_NUMBER
static int	FORCEATTACH_FIELD_NUMBER
static int	MESSAGEBOUND_FIELD_NUMBER
static int	MESSAGEFILTER_FIELD_NUMBER
static int	MESSAGEWINDOWSIZE_FIELD_NUMBER
static int	OPTIONS_FIELD_NUMBER
static com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions>	PARSER Deprecated.

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
PubSubProtocol.SubscribeRequest.CreateOrAttach	getCreateOrAttach() optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
static PubSubProtocol.SubscriptionOptions	getDefaultInstance()
PubSubProtocol.SubscriptionOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnableResubscribe() enable resubscribe
boolean	getForceAttach() force attach subscription which would kill existed channel this option doesn't need to be persisted
int	getMessageBound() optional uint32 messageBound = 3 [default = 0];
String	getMessageFilter() server-side message filter
com.google.protobuf.ByteString	getMessageFilterBytes() server-side message filter
int	getMessageWindowSize() message window size, this is the maximum number of messages which will be delivered without being consumed
PubSubProtocol.Map	getOptions() user customized subscription options
PubSubProtocol.MapOrBuilder	getOptionsOrBuilder() user customized subscription options
com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCreateOrAttach() optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
boolean	hasEnableResubscribe() enable resubscribe
boolean	hasForceAttach() force attach subscription which would kill existed channel this option doesn't need to be persisted
int	hashCode()
boolean	hasMessageBound() optional uint32 messageBound = 3 [default = 0];
boolean	hasMessageFilter() server-side message filter
boolean	hasMessageWindowSize() message window size, this is the maximum number of messages which will be delivered without being consumed
boolean	hasOptions() user customized subscription options
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PubSubProtocol.SubscriptionOptions.Builder	newBuilder()
static PubSubProtocol.SubscriptionOptions.Builder	newBuilder(PubSubProtocol.SubscriptionOptions prototype)
PubSubProtocol.SubscriptionOptions.Builder	newBuilderForType()
protected PubSubProtocol.SubscriptionOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PubSubProtocol.SubscriptionOptions	parseDelimitedFrom(InputStream input)
static PubSubProtocol.SubscriptionOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubProtocol.SubscriptionOptions	parseFrom(byte[] data)
static PubSubProtocol.SubscriptionOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubProtocol.SubscriptionOptions	parseFrom(ByteBuffer data)
static PubSubProtocol.SubscriptionOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubProtocol.SubscriptionOptions	parseFrom(com.google.protobuf.ByteString data)
static PubSubProtocol.SubscriptionOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubProtocol.SubscriptionOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static PubSubProtocol.SubscriptionOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubProtocol.SubscriptionOptions	parseFrom(InputStream input)
static PubSubProtocol.SubscriptionOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions>	parser()
PubSubProtocol.SubscriptionOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FORCEATTACH_FIELD_NUMBER

public static final int FORCEATTACH_FIELD_NUMBER

See Also:

Constant Field Values

CREATEORATTACH_FIELD_NUMBER

public static final int CREATEORATTACH_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGEBOUND_FIELD_NUMBER

public static final int MESSAGEBOUND_FIELD_NUMBER

See Also:

Constant Field Values

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGEFILTER_FIELD_NUMBER

public static final int MESSAGEFILTER_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGEWINDOWSIZE_FIELD_NUMBER

public static final int MESSAGEWINDOWSIZE_FIELD_NUMBER

See Also:

Constant Field Values

ENABLERESUBSCRIBE_FIELD_NUMBER

public static final int ENABLERESUBSCRIBE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions> PARSER

Deprecated.

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasForceAttach

public boolean hasForceAttach()

 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 

optional bool forceAttach = 1 [default = false];

Specified by:

hasForceAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the forceAttach field is set.

getForceAttach

public boolean getForceAttach()

 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 

optional bool forceAttach = 1 [default = false];

Specified by:

getForceAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The forceAttach.

hasCreateOrAttach

public boolean hasCreateOrAttach()

optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];

Specified by:

hasCreateOrAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the createOrAttach field is set.

getCreateOrAttach

public PubSubProtocol.SubscribeRequest.CreateOrAttach getCreateOrAttach()

optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];

Specified by:

getCreateOrAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The createOrAttach.

hasMessageBound

public boolean hasMessageBound()

optional uint32 messageBound = 3 [default = 0];

Specified by:

hasMessageBound in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the messageBound field is set.

getMessageBound

public int getMessageBound()

optional uint32 messageBound = 3 [default = 0];

Specified by:

getMessageBound in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The messageBound.

hasOptions

public boolean hasOptions()

 user customized subscription options
 

optional .Hedwig.Map options = 4;

Specified by:

hasOptions in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the options field is set.

getOptions

public PubSubProtocol.Map getOptions()

 user customized subscription options
 

optional .Hedwig.Map options = 4;

Specified by:

getOptions in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The options.

getOptionsOrBuilder

public PubSubProtocol.MapOrBuilder getOptionsOrBuilder()

 user customized subscription options
 

optional .Hedwig.Map options = 4;

Specified by:

getOptionsOrBuilder in interface PubSubProtocol.SubscriptionOptionsOrBuilder

hasMessageFilter

public boolean hasMessageFilter()

 server-side message filter
 

optional string messageFilter = 5;

Specified by:

hasMessageFilter in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the messageFilter field is set.

getMessageFilter

public String getMessageFilter()

 server-side message filter
 

optional string messageFilter = 5;

Specified by:

getMessageFilter in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The messageFilter.

getMessageFilterBytes

public com.google.protobuf.ByteString getMessageFilterBytes()

 server-side message filter
 

optional string messageFilter = 5;

Specified by:

getMessageFilterBytes in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The bytes for messageFilter.

hasMessageWindowSize

public boolean hasMessageWindowSize()

 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 

optional uint32 messageWindowSize = 6;

Specified by:

hasMessageWindowSize in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the messageWindowSize field is set.

getMessageWindowSize

public int getMessageWindowSize()

 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 

optional uint32 messageWindowSize = 6;

Specified by:

getMessageWindowSize in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The messageWindowSize.

hasEnableResubscribe

public boolean hasEnableResubscribe()

 enable resubscribe
 

optional bool enableResubscribe = 7 [default = true];

Specified by:

hasEnableResubscribe in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

Whether the enableResubscribe field is set.

getEnableResubscribe

public boolean getEnableResubscribe()

 enable resubscribe
 

optional bool enableResubscribe = 7 [default = true];

Specified by:

getEnableResubscribe in interface PubSubProtocol.SubscriptionOptionsOrBuilder

Returns:

The enableResubscribe.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubSubProtocol.SubscriptionOptions parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubSubProtocol.SubscriptionOptions parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static PubSubProtocol.SubscriptionOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

newBuilderForType

public PubSubProtocol.SubscriptionOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PubSubProtocol.SubscriptionOptions.Builder newBuilder()

newBuilder

public static PubSubProtocol.SubscriptionOptions.Builder newBuilder(PubSubProtocol.SubscriptionOptions prototype)

toBuilder

public PubSubProtocol.SubscriptionOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PubSubProtocol.SubscriptionOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PubSubProtocol.SubscriptionOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions> parser()

getParserForType

public com.google.protobuf.Parser<PubSubProtocol.SubscriptionOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PubSubProtocol.SubscriptionOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder