PubSubProtocol.SubscriptionOptions.Builder (bookkeeper 4.2.1 API)

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

All Implemented Interfaces:

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

Enclosing class:

PubSubProtocol.SubscriptionOptions
```
public static final class PubSubProtocol.SubscriptionOptions.Builder
extends com.google.protobuf.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.Builder>
implements PubSubProtocol.SubscriptionOptionsOrBuilder
```
Protobuf type Hedwig.SubscriptionOptions
```
 used in client only
 options are stored in SubscriptionPreferences structure
 
```

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubSubProtocol.SubscriptionOptions`	`build()`
`PubSubProtocol.SubscriptionOptions`	`buildPartial()`
`PubSubProtocol.SubscriptionOptions.Builder`	`clear()`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearCreateOrAttach()` `optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearEnableResubscribe()` `optional bool enableResubscribe = 7 [default = true];`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearForceAttach()` `optional bool forceAttach = 1 [default = false];`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearMessageBound()` `optional uint32 messageBound = 3 [default = 0];`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearMessageFilter()` `optional string messageFilter = 5;`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearMessageWindowSize()` `optional uint32 messageWindowSize = 6;`
`PubSubProtocol.SubscriptionOptions.Builder`	`clearOptions()` `optional .Hedwig.Map options = 4;`
`PubSubProtocol.SubscriptionOptions.Builder`	`clone()`
`PubSubProtocol.SubscribeRequest.CreateOrAttach`	`getCreateOrAttach()` `optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];`
`PubSubProtocol.SubscriptionOptions`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getEnableResubscribe()` `optional bool enableResubscribe = 7 [default = true];`
`boolean`	`getForceAttach()` `optional bool forceAttach = 1 [default = false];`
`int`	`getMessageBound()` `optional uint32 messageBound = 3 [default = 0];`
`String`	`getMessageFilter()` `optional string messageFilter = 5;`
`com.google.protobuf.ByteString`	`getMessageFilterBytes()` `optional string messageFilter = 5;`
`int`	`getMessageWindowSize()` `optional uint32 messageWindowSize = 6;`
`PubSubProtocol.Map`	`getOptions()` `optional .Hedwig.Map options = 4;`
`PubSubProtocol.Map.Builder`	`getOptionsBuilder()` `optional .Hedwig.Map options = 4;`
`PubSubProtocol.MapOrBuilder`	`getOptionsOrBuilder()` `optional .Hedwig.Map options = 4;`
`boolean`	`hasCreateOrAttach()` `optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];`
`boolean`	`hasEnableResubscribe()` `optional bool enableResubscribe = 7 [default = true];`
`boolean`	`hasForceAttach()` `optional bool forceAttach = 1 [default = false];`
`boolean`	`hasMessageBound()` `optional uint32 messageBound = 3 [default = 0];`
`boolean`	`hasMessageFilter()` `optional string messageFilter = 5;`
`boolean`	`hasMessageWindowSize()` `optional uint32 messageWindowSize = 6;`
`boolean`	`hasOptions()` `optional .Hedwig.Map options = 4;`
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`PubSubProtocol.SubscriptionOptions.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`PubSubProtocol.SubscriptionOptions.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`PubSubProtocol.SubscriptionOptions.Builder`	`mergeFrom(PubSubProtocol.SubscriptionOptions other)`
`PubSubProtocol.SubscriptionOptions.Builder`	`mergeOptions(PubSubProtocol.Map value)` `optional .Hedwig.Map options = 4;`
`PubSubProtocol.SubscriptionOptions.Builder`	`setCreateOrAttach(PubSubProtocol.SubscribeRequest.CreateOrAttach value)` `optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];`
`PubSubProtocol.SubscriptionOptions.Builder`	`setEnableResubscribe(boolean value)` `optional bool enableResubscribe = 7 [default = true];`
`PubSubProtocol.SubscriptionOptions.Builder`	`setForceAttach(boolean value)` `optional bool forceAttach = 1 [default = false];`
`PubSubProtocol.SubscriptionOptions.Builder`	`setMessageBound(int value)` `optional uint32 messageBound = 3 [default = 0];`
`PubSubProtocol.SubscriptionOptions.Builder`	`setMessageFilter(String value)` `optional string messageFilter = 5;`
`PubSubProtocol.SubscriptionOptions.Builder`	`setMessageFilterBytes(com.google.protobuf.ByteString value)` `optional string messageFilter = 5;`
`PubSubProtocol.SubscriptionOptions.Builder`	`setMessageWindowSize(int value)` `optional uint32 messageWindowSize = 6;`
`PubSubProtocol.SubscriptionOptions.Builder`	`setOptions(PubSubProtocol.Map.Builder builderForValue)` `optional .Hedwig.Map options = 4;`
`PubSubProtocol.SubscriptionOptions.Builder`	`setOptions(PubSubProtocol.Map value)` `optional .Hedwig.Map options = 4;`

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

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

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

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

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

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.Builder>
  - clear
```
public PubSubProtocol.SubscriptionOptions.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.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.Builder>
  - clone
```
public PubSubProtocol.SubscriptionOptions.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.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.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.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.Builder>
  - getDefaultInstanceForType
```
public PubSubProtocol.SubscriptionOptions getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public PubSubProtocol.SubscriptionOptions build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public PubSubProtocol.SubscriptionOptions buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public PubSubProtocol.SubscriptionOptions.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.SubscriptionOptions.Builder>
  - mergeFrom
```
public PubSubProtocol.SubscriptionOptions.Builder mergeFrom(PubSubProtocol.SubscriptionOptions other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PubSubProtocol.SubscriptionOptions.Builder>
  - mergeFrom
```
public PubSubProtocol.SubscriptionOptions.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.SubscriptionOptions.Builder>
    
    Throws:
    
    IOException
  - hasForceAttach
```
public boolean hasForceAttach()
```
    optional bool forceAttach = 1 [default = false];
```
 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 
```
    Specified by:
    
    hasForceAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getForceAttach
```
public boolean getForceAttach()
```
    optional bool forceAttach = 1 [default = false];
```
 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 
```
    Specified by:
    
    getForceAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setForceAttach
```
public PubSubProtocol.SubscriptionOptions.Builder setForceAttach(boolean value)
```
    optional bool forceAttach = 1 [default = false];
```
 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 
```
  - clearForceAttach
```
public PubSubProtocol.SubscriptionOptions.Builder clearForceAttach()
```
    optional bool forceAttach = 1 [default = false];
```
 force attach subscription which would kill existed channel
 this option doesn't need to be persisted
 
```
  - hasCreateOrAttach
```
public boolean hasCreateOrAttach()
```
    optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
    
    Specified by:
    
    hasCreateOrAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getCreateOrAttach
```
public PubSubProtocol.SubscribeRequest.CreateOrAttach getCreateOrAttach()
```
    optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
    
    Specified by:
    
    getCreateOrAttach in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setCreateOrAttach
```
public PubSubProtocol.SubscriptionOptions.Builder setCreateOrAttach(PubSubProtocol.SubscribeRequest.CreateOrAttach value)
```
    optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
  - clearCreateOrAttach
```
public PubSubProtocol.SubscriptionOptions.Builder clearCreateOrAttach()
```
    optional .Hedwig.SubscribeRequest.CreateOrAttach createOrAttach = 2 [default = CREATE_OR_ATTACH];
  - hasMessageBound
```
public boolean hasMessageBound()
```
    optional uint32 messageBound = 3 [default = 0];
    
    Specified by:
    
    hasMessageBound in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getMessageBound
```
public int getMessageBound()
```
    optional uint32 messageBound = 3 [default = 0];
    
    Specified by:
    
    getMessageBound in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setMessageBound
```
public PubSubProtocol.SubscriptionOptions.Builder setMessageBound(int value)
```
    optional uint32 messageBound = 3 [default = 0];
  - clearMessageBound
```
public PubSubProtocol.SubscriptionOptions.Builder clearMessageBound()
```
    optional uint32 messageBound = 3 [default = 0];
  - hasOptions
```
public boolean hasOptions()
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
    Specified by:
    
    hasOptions in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getOptions
```
public PubSubProtocol.Map getOptions()
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
    Specified by:
    
    getOptions in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setOptions
```
public PubSubProtocol.SubscriptionOptions.Builder setOptions(PubSubProtocol.Map value)
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
  - setOptions
```
public PubSubProtocol.SubscriptionOptions.Builder setOptions(PubSubProtocol.Map.Builder builderForValue)
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
  - mergeOptions
```
public PubSubProtocol.SubscriptionOptions.Builder mergeOptions(PubSubProtocol.Map value)
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
  - clearOptions
```
public PubSubProtocol.SubscriptionOptions.Builder clearOptions()
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
  - getOptionsBuilder
```
public PubSubProtocol.Map.Builder getOptionsBuilder()
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
  - getOptionsOrBuilder
```
public PubSubProtocol.MapOrBuilder getOptionsOrBuilder()
```
    optional .Hedwig.Map options = 4;
```
 user customized subscription options
 
```
    Specified by:
    
    getOptionsOrBuilder in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - hasMessageFilter
```
public boolean hasMessageFilter()
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
    Specified by:
    
    hasMessageFilter in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getMessageFilter
```
public String getMessageFilter()
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
    Specified by:
    
    getMessageFilter in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getMessageFilterBytes
```
public com.google.protobuf.ByteString getMessageFilterBytes()
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
    Specified by:
    
    getMessageFilterBytes in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setMessageFilter
```
public PubSubProtocol.SubscriptionOptions.Builder setMessageFilter(String value)
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
  - clearMessageFilter
```
public PubSubProtocol.SubscriptionOptions.Builder clearMessageFilter()
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
  - setMessageFilterBytes
```
public PubSubProtocol.SubscriptionOptions.Builder setMessageFilterBytes(com.google.protobuf.ByteString value)
```
    optional string messageFilter = 5;
```
 server-side message filter
 
```
  - hasMessageWindowSize
```
public boolean hasMessageWindowSize()
```
    optional uint32 messageWindowSize = 6;
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
    Specified by:
    
    hasMessageWindowSize in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getMessageWindowSize
```
public int getMessageWindowSize()
```
    optional uint32 messageWindowSize = 6;
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
    Specified by:
    
    getMessageWindowSize in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setMessageWindowSize
```
public PubSubProtocol.SubscriptionOptions.Builder setMessageWindowSize(int value)
```
    optional uint32 messageWindowSize = 6;
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
  - clearMessageWindowSize
```
public PubSubProtocol.SubscriptionOptions.Builder clearMessageWindowSize()
```
    optional uint32 messageWindowSize = 6;
```
 message window size, this is the maximum number of messages 
 which will be delivered without being consumed
 
```
  - hasEnableResubscribe
```
public boolean hasEnableResubscribe()
```
    optional bool enableResubscribe = 7 [default = true];
```
 enable resubscribe
 
```
    Specified by:
    
    hasEnableResubscribe in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - getEnableResubscribe
```
public boolean getEnableResubscribe()
```
    optional bool enableResubscribe = 7 [default = true];
```
 enable resubscribe
 
```
    Specified by:
    
    getEnableResubscribe in interface PubSubProtocol.SubscriptionOptionsOrBuilder
  - setEnableResubscribe
```
public PubSubProtocol.SubscriptionOptions.Builder setEnableResubscribe(boolean value)
```
    optional bool enableResubscribe = 7 [default = true];
```
 enable resubscribe
 
```
  - clearEnableResubscribe
```
public PubSubProtocol.SubscriptionOptions.Builder clearEnableResubscribe()
```
    optional bool enableResubscribe = 7 [default = true];
```
 enable resubscribe
 
```

Class PubSubProtocol.SubscriptionOptions.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

clone

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasForceAttach

getForceAttach

setForceAttach

clearForceAttach

hasCreateOrAttach

getCreateOrAttach

setCreateOrAttach

clearCreateOrAttach

hasMessageBound

getMessageBound

setMessageBound

clearMessageBound

hasOptions

getOptions

setOptions

setOptions

mergeOptions

clearOptions

getOptionsBuilder

getOptionsOrBuilder

hasMessageFilter

getMessageFilter

getMessageFilterBytes

setMessageFilter

clearMessageFilter

setMessageFilterBytes

hasMessageWindowSize

getMessageWindowSize

setMessageWindowSize

clearMessageWindowSize

hasEnableResubscribe

getEnableResubscribe

setEnableResubscribe

clearEnableResubscribe