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

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

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>, PubSubConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>, PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>, PubSubJsonDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>, PubSubNamedConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>

Enclosing class:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`dataSetName`
`protected UnsignedShort`	`dataSetWriterId`
`protected Boolean`	`enabled`
`protected DataSetFieldContentMask`	`fieldContentMask`
`protected Map<String,String>`	`jsonMessageExtraFields`
`protected UnsignedInteger`	`keyFrameCount`
`protected JsonDataSetMessageContentMask`	`messageContentMask`
`protected String`	`metaDataQueueName`
`protected Duration`	`metaDataUpdateTime`
`protected String`	`name`
`protected String`	`queueName`
`protected BrokerTransportQualityOfService`	`requestedDeliveryGuarantee`
`protected UnsignedShort`	`writerGroupId`

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
`PubSubMqttJsonDataSetWriterConf`	`build()` Returns an instance of `PubSubMqttJsonDataSetWriterConf` with the values given to this builder.
`String`	`getDataSetName()`
`UnsignedShort`	`getDataSetWriterId()`
`DataSetFieldContentMask`	`getFieldContentMask()`
`Map<String,String>`	`getJsonMessageExtraFields()`
`UnsignedInteger`	`getKeyFrameCount()`
`JsonDataSetMessageContentMask`	`getMessageContentMask()`
`String`	`getMetaDataQueueName()`
`Duration`	`getMetaDataUpdateTime()`
`String`	`getName()`
`String`	`getQueueName()`
`BrokerTransportQualityOfService`	`getRequestedDeliveryGuarantee()`
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the writer group where this writer (to be built) is or is to be added.
`UnsignedShort`	`getWriterGroupId()`
`Boolean`	`isEnabled()`
`PubSubMqttJsonDataSetWriterConf.Builder`	`putJsonMessageExtraFields(String key, String value)` Puts the key-value pair for `PubSubMqttJsonDataSetWriterConf.getJsonMessageExtraFields()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setDataSetName(String dataSetName)` Set the value for `PubSubMqttJsonDataSetWriterConf.getDataSetName()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setDataSetWriterId(UnsignedShort dataSetWriterId)` Set the value for `PubSubMqttJsonDataSetWriterConf.getDataSetWriterId()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setEnabled(Boolean enabled)` Set the value for `PubSubMqttJsonDataSetWriterConf#getEnabled()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setFieldContentMask(DataSetFieldContentMask fieldContentMask)` Set the value for `PubSubMqttJsonDataSetWriterConf.getFieldContentMask()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setKeyFrameCount(UnsignedInteger keyFrameCount)` Set the value for `PubSubMqttJsonDataSetWriterConf.getKeyFrameCount()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setMessageContentMask(JsonDataSetMessageContentMask messageContentMask)` Set the value for `PubSubMqttJsonDataSetWriterConf.getMessageContentMask()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setMetaDataQueueName(String metaDataQueueName)` Set the value for `PubSubMqttJsonDataSetWriterConf.getMetaDataQueueName()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setMetaDataUpdateTime(Duration metaDataUpdateTime)` Set the value for `PubSubMqttJsonDataSetWriterConf.getMetaDataUpdateTime()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setName(String name)` Set the value for `PubSubMqttJsonDataSetWriterConf.getName()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setQueueName(String queueName)` Set the value for `PubSubMqttJsonDataSetWriterConf.getQueueName()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)` Set the value for `PubSubMqttJsonDataSetWriterConf.getRequestedDeliveryGuarantee()`.
`PubSubMqttJsonDataSetWriterConf.Builder`	`setWriterGroupId(UnsignedShort writerGroupId)` Set the value for `PubSubMqttJsonDataSetWriterConf.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
  - name
```
protected String name
```
  - metaDataQueueName
```
protected String metaDataQueueName
```
  - metaDataUpdateTime
```
protected Duration metaDataUpdateTime
```
  - queueName
```
protected String queueName
```
  - requestedDeliveryGuarantee
```
protected BrokerTransportQualityOfService requestedDeliveryGuarantee
```
  - dataSetName
```
protected String dataSetName
```
  - dataSetWriterId
```
protected UnsignedShort dataSetWriterId
```
  - fieldContentMask
```
protected DataSetFieldContentMask fieldContentMask
```
  - keyFrameCount
```
protected UnsignedInteger keyFrameCount
```
  - writerGroupId
```
protected UnsignedShort writerGroupId
```
  - enabled
```
protected Boolean enabled
```
  - messageContentMask
```
protected JsonDataSetMessageContentMask messageContentMask
```
  - jsonMessageExtraFields
```
protected Map<String,String> jsonMessageExtraFields
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - getTransportProfile
```
public final PubSubTransportProfile getTransportProfile()
```
    Description copied from interface: PubSubDataSetWriterConf.Builder
    
    Returns the TransportProfile (uri) of the writer group where this writer (to be built) is or is to be added. This defines both the transport and encoding of the writer.
  - 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<PubSubMqttJsonDataSetWriterConf.Builder>
  - getName
```
public String getName()
```
  - getMetaDataQueueName
```
public String getMetaDataQueueName()
```
  - getMetaDataUpdateTime
```
public Duration getMetaDataUpdateTime()
```
  - getQueueName
```
public String getQueueName()
```
  - getRequestedDeliveryGuarantee
```
public BrokerTransportQualityOfService getRequestedDeliveryGuarantee()
```
  - getDataSetName
```
public String getDataSetName()
```
  - getDataSetWriterId
```
public UnsignedShort getDataSetWriterId()
```
  - getFieldContentMask
```
public DataSetFieldContentMask getFieldContentMask()
```
  - getKeyFrameCount
```
public UnsignedInteger getKeyFrameCount()
```
  - getWriterGroupId
```
public UnsignedShort getWriterGroupId()
```
  - isEnabled
```
public Boolean isEnabled()
```
  - getMessageContentMask
```
public JsonDataSetMessageContentMask getMessageContentMask()
```
  - getJsonMessageExtraFields
```
public Map<String,String> getJsonMessageExtraFields()
```
  - setName
```
public PubSubMqttJsonDataSetWriterConf.Builder setName(String name)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setMetaDataQueueName
```
public PubSubMqttJsonDataSetWriterConf.Builder setMetaDataQueueName(String metaDataQueueName)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getMetaDataQueueName(). Returns itself for method chaining.
    
    Specified by:
    
    setMetaDataQueueName in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setMetaDataUpdateTime
```
public PubSubMqttJsonDataSetWriterConf.Builder setMetaDataUpdateTime(Duration metaDataUpdateTime)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getMetaDataUpdateTime(). Returns itself for method chaining.
    
    Specified by:
    
    setMetaDataUpdateTime in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setQueueName
```
public PubSubMqttJsonDataSetWriterConf.Builder setQueueName(String queueName)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getQueueName(). Returns itself for method chaining.
    
    Specified by:
    
    setQueueName in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setRequestedDeliveryGuarantee
```
public PubSubMqttJsonDataSetWriterConf.Builder setRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getRequestedDeliveryGuarantee(). Returns itself for method chaining.
    
    Specified by:
    
    setRequestedDeliveryGuarantee in interface PubSubBrokerTransportSettingsConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setDataSetName
```
public PubSubMqttJsonDataSetWriterConf.Builder setDataSetName(String dataSetName)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getDataSetName(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetName in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setDataSetWriterId
```
public PubSubMqttJsonDataSetWriterConf.Builder setDataSetWriterId(UnsignedShort dataSetWriterId)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getDataSetWriterId(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetWriterId in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setFieldContentMask
```
public PubSubMqttJsonDataSetWriterConf.Builder setFieldContentMask(DataSetFieldContentMask fieldContentMask)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getFieldContentMask(). Returns itself for method chaining.
    
    Specified by:
    
    setFieldContentMask in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setKeyFrameCount
```
public PubSubMqttJsonDataSetWriterConf.Builder setKeyFrameCount(UnsignedInteger keyFrameCount)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getKeyFrameCount(). Returns itself for method chaining.
    
    Specified by:
    
    setKeyFrameCount in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setWriterGroupId
```
public PubSubMqttJsonDataSetWriterConf.Builder setWriterGroupId(UnsignedShort writerGroupId)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getWriterGroupId(). Returns itself for method chaining.
    
    Specified by:
    
    setWriterGroupId in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setEnabled
```
public PubSubMqttJsonDataSetWriterConf.Builder setEnabled(Boolean enabled)
```
    Set the value for PubSubMqttJsonDataSetWriterConf#getEnabled(). Returns itself for method chaining.
    
    Specified by:
    
    setEnabled in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - setMessageContentMask
```
public PubSubMqttJsonDataSetWriterConf.Builder setMessageContentMask(JsonDataSetMessageContentMask messageContentMask)
```
    Set the value for PubSubMqttJsonDataSetWriterConf.getMessageContentMask(). Returns itself for method chaining.
    
    Specified by:
    
    setMessageContentMask in interface PubSubJsonDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
  - putJsonMessageExtraFields
```
public PubSubMqttJsonDataSetWriterConf.Builder putJsonMessageExtraFields(String key,
                                                                         String value)
```
    Puts the key-value pair for PubSubMqttJsonDataSetWriterConf.getJsonMessageExtraFields(). Returns itself for method chaining.
  - build
```
public PubSubMqttJsonDataSetWriterConf build()
```
    Returns an instance of PubSubMqttJsonDataSetWriterConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>
    
    Specified by:
    
    build in interface PubSubDataSetWriterConf.Builder<PubSubMqttJsonDataSetWriterConf.Builder>

Class PubSubMqttJsonDataSetWriterConf.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

name

metaDataQueueName

metaDataUpdateTime

queueName

requestedDeliveryGuarantee

dataSetName

dataSetWriterId

fieldContentMask

keyFrameCount

writerGroupId

enabled

messageContentMask

jsonMessageExtraFields

Constructor Detail

Builder

Method Detail

getTransportProfile

specification

getName

getMetaDataQueueName

getMetaDataUpdateTime

getQueueName

getRequestedDeliveryGuarantee

getDataSetName

getDataSetWriterId

getFieldContentMask

getKeyFrameCount

getWriterGroupId

isEnabled

getMessageContentMask

getJsonMessageExtraFields

setName

setMetaDataQueueName

setMetaDataUpdateTime

setQueueName

setRequestedDeliveryGuarantee

setDataSetName

setDataSetWriterId

setFieldContentMask

setKeyFrameCount

setWriterGroupId

setEnabled

setMessageContentMask

putJsonMessageExtraFields

build