public static interface ProtocolBufferTopicDetails.Builder extends TopicDetails.Builder<ProtocolBufferTopicDetails.Builder,ProtocolBufferTopicDetails>
Modifier and Type | Method and Description |
---|---|
ProtocolBufferTopicDetails.Builder |
deletionValue(String value)
Allows a deletion value to be specified for use with 'string' type
optional fields.
|
ProtocolBufferTopicDetails.Builder |
messageDetails(String protoClass,
String messageName)
Sets the Protocol Buffers message details.
|
ProtocolBufferTopicDetails.Builder |
updateMode(ProtocolBufferTopicDetails.Attributes.UpdateMode updateMode)
Sets the update mode.
|
build, property, reference, reset, tidyOnUnsubscribe
ProtocolBufferTopicDetails.Builder messageDetails(String protoClass, String messageName) throws IllegalArgumentException
protoClass
- the full name of the outer class containing the
required message definition. This class must exist at the
server. Such a class will have been generated from a
.proto
file using the protoc
compilermessageName
- the name of the message within the specified class
that defines the topic contentIllegalArgumentException
- if either protoClass
or
messageName
is nullProtocolBufferTopicDetails.Builder updateMode(ProtocolBufferTopicDetails.Attributes.UpdateMode updateMode)
If the mode is not explicitly set, PARTIAL
is assumed
updateMode
- the update modeIllegalArgumentException
- if updateMode
is nullProtocolBufferTopicDetails.Builder deletionValue(String value) throws IllegalArgumentException
The purpose of this value is to allow a value which will be interpreted as meaning that an optional field has been removed.
When operating in full
mode then when input
messages do not have values for optional string fields and the
current topic state does, it is assumed that the field is being
removed and notification of this removal will be passed to the client
by sending the field with this value.
When operating in partial
mode, it is
possible to use the deletion value to indicate the removal of a field
in the update message and then field removal will be notified to the
clients using the same value.
If no value is explicitly specified,
DEFAULT_DELETION_VALUE
is
assumed.
value
- the deletion value which may be one or more characters
which the client can interpret as meaning that an optional
field has been removedIllegalArgumentException
- if value
is nullCopyright © 2016 Push Technology Ltd. All Rights Reserved.