PubSubProtocol.SubscriptionPreferences.Builder (bookkeeper 4.3.2 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
    - - org.apache.hedwig.protocol.PubSubProtocol.SubscriptionPreferences.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, PubSubProtocol.SubscriptionPreferencesOrBuilder

Enclosing class:

PubSubProtocol.SubscriptionPreferences
```
public static final class PubSubProtocol.SubscriptionPreferences.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
implements PubSubProtocol.SubscriptionPreferencesOrBuilder
```
```
 record all preferences for a subscription,
 would be serialized to be stored in meta store
 
```
Protobuf type Hedwig.SubscriptionPreferences

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubSubProtocol.SubscriptionPreferences.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PubSubProtocol.SubscriptionPreferences`	`build()`
`PubSubProtocol.SubscriptionPreferences`	`buildPartial()`
`PubSubProtocol.SubscriptionPreferences.Builder`	`clear()`
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearMessageBound()` message bound
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearMessageFilter()` server-side message filter
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearMessageWindowSize()` message window size, this is the maximum number of messages which will be delivered without being consumed
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`clearOptions()` user customized subscription options
`PubSubProtocol.SubscriptionPreferences.Builder`	`clone()`
`PubSubProtocol.SubscriptionPreferences`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getMessageBound()` message bound
`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.Map.Builder`	`getOptionsBuilder()` user customized subscription options
`PubSubProtocol.MapOrBuilder`	`getOptionsOrBuilder()` user customized subscription options
`boolean`	`hasMessageBound()` message bound
`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()`
`PubSubProtocol.SubscriptionPreferences.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`mergeFrom(PubSubProtocol.SubscriptionPreferences other)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`mergeOptions(PubSubProtocol.Map value)` user customized subscription options
`PubSubProtocol.SubscriptionPreferences.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`setMessageBound(int value)` message bound
`PubSubProtocol.SubscriptionPreferences.Builder`	`setMessageFilter(String value)` server-side message filter
`PubSubProtocol.SubscriptionPreferences.Builder`	`setMessageFilterBytes(com.google.protobuf.ByteString value)` server-side message filter
`PubSubProtocol.SubscriptionPreferences.Builder`	`setMessageWindowSize(int value)` message window size, this is the maximum number of messages which will be delivered without being consumed
`PubSubProtocol.SubscriptionPreferences.Builder`	`setOptions(PubSubProtocol.Map.Builder builderForValue)` user customized subscription options
`PubSubProtocol.SubscriptionPreferences.Builder`	`setOptions(PubSubProtocol.Map value)` user customized subscription options
`PubSubProtocol.SubscriptionPreferences.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`PubSubProtocol.SubscriptionPreferences.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - clear
```
public PubSubProtocol.SubscriptionPreferences.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - getDefaultInstanceForType
```
public PubSubProtocol.SubscriptionPreferences getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public PubSubProtocol.SubscriptionPreferences build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public PubSubProtocol.SubscriptionPreferences buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public PubSubProtocol.SubscriptionPreferences.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - setField
```
public PubSubProtocol.SubscriptionPreferences.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - clearField
```
public PubSubProtocol.SubscriptionPreferences.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - clearOneof
```
public PubSubProtocol.SubscriptionPreferences.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - setRepeatedField
```
public PubSubProtocol.SubscriptionPreferences.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                       int index,
                                                                       Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - addRepeatedField
```
public PubSubProtocol.SubscriptionPreferences.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                       Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - mergeFrom
```
public PubSubProtocol.SubscriptionPreferences.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - mergeFrom
```
public PubSubProtocol.SubscriptionPreferences.Builder mergeFrom(PubSubProtocol.SubscriptionPreferences other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - mergeFrom
```
public PubSubProtocol.SubscriptionPreferences.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
    
    Throws:
    
    IOException
  - hasOptions
```
public boolean hasOptions()
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
    Specified by:
    
    hasOptions in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    Whether the options field is set.
  - getOptions
```
public PubSubProtocol.Map getOptions()
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
    Specified by:
    
    getOptions in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    The options.
  - setOptions
```
public PubSubProtocol.SubscriptionPreferences.Builder setOptions(PubSubProtocol.Map value)
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
  - setOptions
```
public PubSubProtocol.SubscriptionPreferences.Builder setOptions(PubSubProtocol.Map.Builder builderForValue)
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
  - mergeOptions
```
public PubSubProtocol.SubscriptionPreferences.Builder mergeOptions(PubSubProtocol.Map value)
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
  - clearOptions
```
public PubSubProtocol.SubscriptionPreferences.Builder clearOptions()
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
  - getOptionsBuilder
```
public PubSubProtocol.Map.Builder getOptionsBuilder()
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
  - getOptionsOrBuilder
```
public PubSubProtocol.MapOrBuilder getOptionsOrBuilder()
```
```
 user customized subscription options
 
```
    optional .Hedwig.Map options = 1;
    Specified by:
    
    getOptionsOrBuilder in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
  - hasMessageBound
```
public boolean hasMessageBound()
```
```
 message bound
 
```
    optional uint32 messageBound = 2;
    Specified by:
    
    hasMessageBound in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    Whether the messageBound field is set.
  - getMessageBound
```
public int getMessageBound()
```
```
 message bound
 
```
    optional uint32 messageBound = 2;
    Specified by:
    
    getMessageBound in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    The messageBound.
  - setMessageBound
```
public PubSubProtocol.SubscriptionPreferences.Builder setMessageBound(int value)
```
```
 message bound
 
```
    optional uint32 messageBound = 2;
    Parameters:
    
    value - The messageBound to set.
    
    Returns:
    
    This builder for chaining.
  - clearMessageBound
```
public PubSubProtocol.SubscriptionPreferences.Builder clearMessageBound()
```
```
 message bound
 
```
    optional uint32 messageBound = 2;
    Returns:
    
    This builder for chaining.
  - hasMessageFilter
```
public boolean hasMessageFilter()
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Specified by:
    
    hasMessageFilter in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    Whether the messageFilter field is set.
  - getMessageFilter
```
public String getMessageFilter()
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Specified by:
    
    getMessageFilter in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    The messageFilter.
  - getMessageFilterBytes
```
public com.google.protobuf.ByteString getMessageFilterBytes()
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Specified by:
    
    getMessageFilterBytes in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    The bytes for messageFilter.
  - setMessageFilter
```
public PubSubProtocol.SubscriptionPreferences.Builder setMessageFilter(String value)
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Parameters:
    
    value - The messageFilter to set.
    
    Returns:
    
    This builder for chaining.
  - clearMessageFilter
```
public PubSubProtocol.SubscriptionPreferences.Builder clearMessageFilter()
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Returns:
    
    This builder for chaining.
  - setMessageFilterBytes
```
public PubSubProtocol.SubscriptionPreferences.Builder setMessageFilterBytes(com.google.protobuf.ByteString value)
```
```
 server-side message filter
 
```
    optional string messageFilter = 3;
    Parameters:
    
    value - The bytes for messageFilter to set.
    
    Returns:
    
    This builder for chaining.
  - hasMessageWindowSize
```
public boolean hasMessageWindowSize()
```
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
    optional uint32 messageWindowSize = 4;
    Specified by:
    
    hasMessageWindowSize in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    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 = 4;
    Specified by:
    
    getMessageWindowSize in interface PubSubProtocol.SubscriptionPreferencesOrBuilder
    
    Returns:
    
    The messageWindowSize.
  - setMessageWindowSize
```
public PubSubProtocol.SubscriptionPreferences.Builder setMessageWindowSize(int value)
```
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
    optional uint32 messageWindowSize = 4;
    Parameters:
    
    value - The messageWindowSize to set.
    
    Returns:
    
    This builder for chaining.
  - clearMessageWindowSize
```
public PubSubProtocol.SubscriptionPreferences.Builder clearMessageWindowSize()
```
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
    optional uint32 messageWindowSize = 4;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final PubSubProtocol.SubscriptionPreferences.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>
  - mergeUnknownFields
```
public final PubSubProtocol.SubscriptionPreferences.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubProtocol.SubscriptionPreferences.Builder>

Class PubSubProtocol.SubscriptionPreferences.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasOptions

getOptions

setOptions

setOptions

mergeOptions

clearOptions

getOptionsBuilder

getOptionsOrBuilder

hasMessageBound

getMessageBound

setMessageBound

clearMessageBound

hasMessageFilter

getMessageFilter

getMessageFilterBytes

setMessageFilter

clearMessageFilter

setMessageFilterBytes

hasMessageWindowSize

getMessageWindowSize

setMessageWindowSize

clearMessageWindowSize

setUnknownFields

mergeUnknownFields