PubSubMqttJsonWriterGroupConf.Builder (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.pubsub.PubSubMqttJsonWriterGroupConf.Builder

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>, PubSubConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>, PubSubGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>, PubSubJsonWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>, PubSubNamedConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>, PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>

Enclosing class:

PubSubMqttJsonWriterGroupConf
```
public static final class PubSubMqttJsonWriterGroupConf.Builder
extends Object
```
Builder for PubSubMqttJsonWriterGroupConf.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`enabled`
`protected Map<String,String>`	`jsonHeaderExtraFields`
`protected Duration`	`keepAliveTime`
`protected List<String>`	`localeIds`
`protected UnsignedInteger`	`maxNetworkMessageSize`
`protected JsonNetworkMessageContentMask`	`messageContentMask`
`protected String`	`metaDataQueueName`
`protected Duration`	`metaDataUpdateTime`
`protected String`	`name`
`protected UnsignedByte`	`priority`
`protected Duration`	`publishingInterval`
`protected String`	`queueName`
`protected BrokerTransportQualityOfService`	`requestedDeliveryGuarantee`
`protected PubSubSecurityConf`	`securityConf`
`protected UnsignedShort`	`writerGroupId`
`protected Map<String,PubSubMqttJsonDataSetWriterConf>`	`writers`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder()

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubSubMqttJsonWriterGroupConf.Builder`	`addLocaleIds(String localeIds)` Adds the value as an element for `PubSubMqttJsonWriterGroupConf.getLocaleIds()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`addOrReplaceWriter(PubSubDataSetWriterConf value)` Adds the given writer to this writer group.
`PubSubMqttJsonWriterGroupConf.Builder`	`addOrReplaceWriter(PubSubMqttJsonDataSetWriterConf value)` Adds a Writer to the conf or replaces any existing Writer one with the same `PubSubMqttJsonDataSetWriterConf.getName()`.
`PubSubMqttJsonWriterGroupConf`	`build()` Returns an instance of `PubSubMqttJsonWriterGroupConf` with the values given to this builder.
`Map<String,String>`	`getJsonHeaderExtraFields()`
`Duration`	`getKeepAliveTime()`
`List<String>`	`getLocaleIds()`
`UnsignedInteger`	`getMaxNetworkMessageSize()`
`JsonNetworkMessageContentMask`	`getMessageContentMask()`
`String`	`getMetaDataQueueName()`
`Duration`	`getMetaDataUpdateTime()`
`String`	`getName()`
`UnsignedByte`	`getPriority()`
`Duration`	`getPublishingInterval()`
`String`	`getQueueName()`
`BrokerTransportQualityOfService`	`getRequestedDeliveryGuarantee()`
`PubSubSecurityConf`	`getSecurityConf()`
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the connection where this group (to be built) is or is to be added.
`UnsignedShort`	`getWriterGroupId()`
`Map<String,PubSubMqttJsonDataSetWriterConf>`	`getWriters()`
`Boolean`	`isEnabled()`
`PubSubMqttJsonWriterGroupConf.Builder`	`putJsonHeaderExtraFields(String key, String value)` Puts the key-value pair for `PubSubMqttJsonWriterGroupConf.getJsonHeaderExtraFields()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`removeWriter(String name)` Removes writer that has the given name, if one exist in this group.
`PubSubMqttJsonWriterGroupConf.Builder`	`setEnabled(Boolean enabled)` Set the value for `PubSubMqttJsonWriterGroupConf#getEnabled()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setKeepAliveTime(Duration keepAliveTime)` Set the value for `PubSubMqttJsonWriterGroupConf.getKeepAliveTime()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)` Set the value for `PubSubMqttJsonWriterGroupConf.getMaxNetworkMessageSize()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setMessageContentMask(JsonNetworkMessageContentMask messageContentMask)` Set the value for `PubSubMqttJsonWriterGroupConf.getMessageContentMask()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setMetaDataQueueName(String metaDataQueueName)` Set the value for `PubSubMqttJsonWriterGroupConf.getMetaDataQueueName()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setMetaDataUpdateTime(Duration metaDataUpdateTime)` Set the value for `PubSubMqttJsonWriterGroupConf.getMetaDataUpdateTime()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setName(String name)` Set the value for `PubSubMqttJsonWriterGroupConf.getName()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setPriority(UnsignedByte priority)` Set the value for `PubSubMqttJsonWriterGroupConf.getPriority()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setPublishingInterval(Duration publishingInterval)` Set the value for `PubSubMqttJsonWriterGroupConf.getPublishingInterval()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setQueueName(String queueName)` Set the value for `PubSubMqttJsonWriterGroupConf.getQueueName()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)` Set the value for `PubSubMqttJsonWriterGroupConf.getRequestedDeliveryGuarantee()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setSecurityConf(PubSubSecurityConf securityConf)` Set the value for `PubSubMqttJsonWriterGroupConf.getSecurityConf()`.
`PubSubMqttJsonWriterGroupConf.Builder`	`setWriterGroupId(UnsignedShort writerGroupId)` Set the value for `PubSubMqttJsonWriterGroupConf.getWriterGroupId()`.
`PubSubConfSpecification`	`specification()` Returns the specification of this object.

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

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf.Builder
get, get, set, set, setAll

- Field Detail
  - metaDataQueueName
```
protected String metaDataQueueName
```
  - metaDataUpdateTime
```
protected Duration metaDataUpdateTime
```
  - queueName
```
protected String queueName
```
  - requestedDeliveryGuarantee
```
protected BrokerTransportQualityOfService requestedDeliveryGuarantee
```
  - maxNetworkMessageSize
```
protected UnsignedInteger maxNetworkMessageSize
```
  - name
```
protected String name
```
  - securityConf
```
protected PubSubSecurityConf securityConf
```
  - enabled
```
protected Boolean enabled
```
  - keepAliveTime
```
protected Duration keepAliveTime
```
  - localeIds
```
protected List<String> localeIds
```
  - priority
```
protected UnsignedByte priority
```
  - publishingInterval
```
protected Duration publishingInterval
```
  - writerGroupId
```
protected UnsignedShort writerGroupId
```
  - messageContentMask
```
protected JsonNetworkMessageContentMask messageContentMask
```
  - jsonHeaderExtraFields
```
protected Map<String,String> jsonHeaderExtraFields
```
  - writers
```
protected Map<String,PubSubMqttJsonDataSetWriterConf> writers
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - addOrReplaceWriter
```
public PubSubMqttJsonWriterGroupConf.Builder addOrReplaceWriter(PubSubDataSetWriterConf value)
```
    Description copied from interface: PubSubWriterGroupConf.Builder
    
    Adds the given writer to this writer group. Important! The given writer conf must be of equal PubSubTransportProfile implementation as this group (e.g. UDP-UADP Writer for UDP-UADP WriterGroup), otherwise throws IllegalArgumentException. Replaces any existing Writer with the same name as the given one.
  - getTransportProfile
```
public final PubSubTransportProfile getTransportProfile()
```
    Description copied from interface: PubSubGroupConf.Builder
    
    Returns the TransportProfile (uri) of the connection where this group (to be built) is or is to be added. This defines both the transport and encoding of the group.
  - specification
```
public PubSubConfSpecification specification()
```
    Description copied from interface: PubSubConf.Builder
    
    Returns the specification of this object. Can be used to dynamically set the fields of the PubSubConf object.
    
    Specified by:
    
    specification in interface PubSubConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - getMetaDataQueueName
```
public String getMetaDataQueueName()
```
  - getMetaDataUpdateTime
```
public Duration getMetaDataUpdateTime()
```
  - getQueueName
```
public String getQueueName()
```
  - getRequestedDeliveryGuarantee
```
public BrokerTransportQualityOfService getRequestedDeliveryGuarantee()
```
  - getMaxNetworkMessageSize
```
public UnsignedInteger getMaxNetworkMessageSize()
```
  - getName
```
public String getName()
```
  - getSecurityConf
```
public PubSubSecurityConf getSecurityConf()
```
  - isEnabled
```
public Boolean isEnabled()
```
  - getKeepAliveTime
```
public Duration getKeepAliveTime()
```
  - getLocaleIds
```
public List<String> getLocaleIds()
```
  - getPriority
```
public UnsignedByte getPriority()
```
  - getPublishingInterval
```
public Duration getPublishingInterval()
```
  - getWriterGroupId
```
public UnsignedShort getWriterGroupId()
```
  - getMessageContentMask
```
public JsonNetworkMessageContentMask getMessageContentMask()
```
  - getJsonHeaderExtraFields
```
public Map<String,String> getJsonHeaderExtraFields()
```
  - getWriters
```
public Map<String,PubSubMqttJsonDataSetWriterConf> getWriters()
```
  - setMetaDataQueueName
```
public PubSubMqttJsonWriterGroupConf.Builder setMetaDataQueueName(String metaDataQueueName)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getMetaDataQueueName(). Returns itself for method chaining.
    
    Specified by:
    
    setMetaDataQueueName in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setMetaDataUpdateTime
```
public PubSubMqttJsonWriterGroupConf.Builder setMetaDataUpdateTime(Duration metaDataUpdateTime)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getMetaDataUpdateTime(). Returns itself for method chaining.
    
    Specified by:
    
    setMetaDataUpdateTime in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setQueueName
```
public PubSubMqttJsonWriterGroupConf.Builder setQueueName(String queueName)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getQueueName(). Returns itself for method chaining.
    
    Specified by:
    
    setQueueName in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setRequestedDeliveryGuarantee
```
public PubSubMqttJsonWriterGroupConf.Builder setRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getRequestedDeliveryGuarantee(). Returns itself for method chaining.
    
    Specified by:
    
    setRequestedDeliveryGuarantee in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setMaxNetworkMessageSize
```
public PubSubMqttJsonWriterGroupConf.Builder setMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getMaxNetworkMessageSize(). Returns itself for method chaining.
    
    Specified by:
    
    setMaxNetworkMessageSize in interface PubSubGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setName
```
public PubSubMqttJsonWriterGroupConf.Builder setName(String name)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setSecurityConf
```
public PubSubMqttJsonWriterGroupConf.Builder setSecurityConf(PubSubSecurityConf securityConf)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getSecurityConf(). Returns itself for method chaining.
    
    Specified by:
    
    setSecurityConf in interface PubSubGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setEnabled
```
public PubSubMqttJsonWriterGroupConf.Builder setEnabled(Boolean enabled)
```
    Set the value for PubSubMqttJsonWriterGroupConf#getEnabled(). Returns itself for method chaining.
    
    Specified by:
    
    setEnabled in interface PubSubGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setKeepAliveTime
```
public PubSubMqttJsonWriterGroupConf.Builder setKeepAliveTime(Duration keepAliveTime)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getKeepAliveTime(). Returns itself for method chaining.
    
    Specified by:
    
    setKeepAliveTime in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - addLocaleIds
```
public PubSubMqttJsonWriterGroupConf.Builder addLocaleIds(String localeIds)
```
    Adds the value as an element for PubSubMqttJsonWriterGroupConf.getLocaleIds(). Returns itself for method chaining.
    
    Specified by:
    
    addLocaleIds in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setPriority
```
public PubSubMqttJsonWriterGroupConf.Builder setPriority(UnsignedByte priority)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getPriority(). Returns itself for method chaining.
    
    Specified by:
    
    setPriority in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setPublishingInterval
```
public PubSubMqttJsonWriterGroupConf.Builder setPublishingInterval(Duration publishingInterval)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getPublishingInterval(). Returns itself for method chaining.
    
    Specified by:
    
    setPublishingInterval in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setWriterGroupId
```
public PubSubMqttJsonWriterGroupConf.Builder setWriterGroupId(UnsignedShort writerGroupId)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getWriterGroupId(). Returns itself for method chaining.
    
    Specified by:
    
    setWriterGroupId in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - setMessageContentMask
```
public PubSubMqttJsonWriterGroupConf.Builder setMessageContentMask(JsonNetworkMessageContentMask messageContentMask)
```
    Set the value for PubSubMqttJsonWriterGroupConf.getMessageContentMask(). Returns itself for method chaining.
    
    Specified by:
    
    setMessageContentMask in interface PubSubJsonWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - putJsonHeaderExtraFields
```
public PubSubMqttJsonWriterGroupConf.Builder putJsonHeaderExtraFields(String key,
                                                                      String value)
```
    Puts the key-value pair for PubSubMqttJsonWriterGroupConf.getJsonHeaderExtraFields(). Returns itself for method chaining.
  - addOrReplaceWriter
```
public PubSubMqttJsonWriterGroupConf.Builder addOrReplaceWriter(PubSubMqttJsonDataSetWriterConf value)
```
    Adds a Writer to the conf or replaces any existing Writer one with the same PubSubMqttJsonDataSetWriterConf.getName().
  - build
```
public PubSubMqttJsonWriterGroupConf build()
```
    Returns an instance of PubSubMqttJsonWriterGroupConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
    
    Specified by:
    
    build in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>
  - removeWriter
```
public PubSubMqttJsonWriterGroupConf.Builder removeWriter(String name)
```
    Description copied from interface: PubSubWriterGroupConf.Builder
    
    Removes writer that has the given name, if one exist in this group.
    
    Specified by:
    
    removeWriter in interface PubSubWriterGroupConf.Builder<PubSubMqttJsonWriterGroupConf.Builder>

Class PubSubMqttJsonWriterGroupConf.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf.Builder

Field Detail

metaDataQueueName

metaDataUpdateTime

queueName

requestedDeliveryGuarantee

maxNetworkMessageSize

name

securityConf

enabled

keepAliveTime

localeIds

priority

publishingInterval

writerGroupId

messageContentMask

jsonHeaderExtraFields

writers

Constructor Detail

Builder

Method Detail

addOrReplaceWriter

getTransportProfile

specification

getMetaDataQueueName

getMetaDataUpdateTime

getQueueName

getRequestedDeliveryGuarantee

getMaxNetworkMessageSize

getName

getSecurityConf

isEnabled

getKeepAliveTime

getLocaleIds

getPriority

getPublishingInterval

getWriterGroupId

getMessageContentMask

getJsonHeaderExtraFields

getWriters

setMetaDataQueueName

setMetaDataUpdateTime

setQueueName

setRequestedDeliveryGuarantee

setMaxNetworkMessageSize

setName

setSecurityConf

setEnabled

setKeepAliveTime

addLocaleIds

setPriority

setPublishingInterval

setWriterGroupId

setMessageContentMask

putJsonHeaderExtraFields

addOrReplaceWriter

build

removeWriter