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

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

All Implemented Interfaces:

PubSubConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>, PubSubGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>, PubSubNamedConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>, PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>, PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>

Enclosing class:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected DataSetOrderingType`	`dataSetOrdering`
`protected Boolean`	`enabled`
`protected UnsignedInteger`	`groupVersion`
`protected Duration`	`keepAliveTime`
`protected List<String>`	`localeIds`
`protected UnsignedInteger`	`maxNetworkMessageSize`
`protected UadpNetworkMessageContentMask`	`messageContentMask`
`protected String`	`name`
`protected UnsignedByte`	`priority`
`protected Duration`	`publishingInterval`
`protected PubSubPublishingOffsets`	`publishingOffset`
`protected Duration`	`samplingOffset`
`protected PubSubSecurityConf`	`securityConf`
`protected UnsignedShort`	`writerGroupId`
`protected Map<String,PubSubUdpUadpDataSetWriterConf>`	`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
`PubSubUdpUadpWriterGroupConf.Builder`	`addLocaleIds(String localeIds)` Adds the value as an element for `PubSubUdpUadpWriterGroupConf.getLocaleIds()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`addOrReplaceWriter(PubSubDataSetWriterConf value)` Adds the given writer to this writer group.
`PubSubUdpUadpWriterGroupConf.Builder`	`addOrReplaceWriter(PubSubUdpUadpDataSetWriterConf value)` Adds a Writer to the conf or replaces any existing Writer one with the same `PubSubUdpUadpDataSetWriterConf.getName()`.
`PubSubUdpUadpWriterGroupConf`	`build()` Returns an instance of `PubSubUdpUadpWriterGroupConf` with the values given to this builder.
`DataSetOrderingType`	`getDataSetOrdering()`
`UnsignedInteger`	`getGroupVersion()`
`Duration`	`getKeepAliveTime()`
`List<String>`	`getLocaleIds()`
`UnsignedInteger`	`getMaxNetworkMessageSize()`
`UadpNetworkMessageContentMask`	`getMessageContentMask()`
`String`	`getName()`
`UnsignedByte`	`getPriority()`
`Duration`	`getPublishingInterval()`
`PubSubPublishingOffsets`	`getPublishingOffset()`
`Duration`	`getSamplingOffset()`
`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,PubSubUdpUadpDataSetWriterConf>`	`getWriters()`
`Boolean`	`isEnabled()`
`PubSubUdpUadpWriterGroupConf.Builder`	`removeWriter(String name)` Removes writer that has the given name, if one exist in this group.
`PubSubUdpUadpWriterGroupConf.Builder`	`setDataSetOrdering(DataSetOrderingType dataSetOrdering)` Set the value for `PubSubUdpUadpWriterGroupConf.getDataSetOrdering()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setEnabled(Boolean enabled)` Set the value for `PubSubUdpUadpWriterGroupConf#getEnabled()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setGroupVersion(UnsignedInteger groupVersion)` Set the value for `PubSubUdpUadpWriterGroupConf.getGroupVersion()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setKeepAliveTime(Duration keepAliveTime)` Set the value for `PubSubUdpUadpWriterGroupConf.getKeepAliveTime()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)` Set the value for `PubSubUdpUadpWriterGroupConf.getMaxNetworkMessageSize()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setMessageContentMask(UadpNetworkMessageContentMask messageContentMask)` Set the value for `PubSubUdpUadpWriterGroupConf.getMessageContentMask()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setName(String name)` Set the value for `PubSubUdpUadpWriterGroupConf.getName()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setPriority(UnsignedByte priority)` Set the value for `PubSubUdpUadpWriterGroupConf.getPriority()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setPublishingInterval(Duration publishingInterval)` Set the value for `PubSubUdpUadpWriterGroupConf.getPublishingInterval()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setPublishingOffset(PubSubPublishingOffsets publishingOffset)` Set the value for `PubSubUdpUadpWriterGroupConf.getPublishingOffset()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setSamplingOffset(Duration samplingOffset)` Set the value for `PubSubUdpUadpWriterGroupConf.getSamplingOffset()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setSecurityConf(PubSubSecurityConf securityConf)` Set the value for `PubSubUdpUadpWriterGroupConf.getSecurityConf()`.
`PubSubUdpUadpWriterGroupConf.Builder`	`setWriterGroupId(UnsignedShort writerGroupId)` Set the value for `PubSubUdpUadpWriterGroupConf.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
  - 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
```
  - dataSetOrdering
```
protected DataSetOrderingType dataSetOrdering
```
  - groupVersion
```
protected UnsignedInteger groupVersion
```
  - messageContentMask
```
protected UadpNetworkMessageContentMask messageContentMask
```
  - publishingOffset
```
protected PubSubPublishingOffsets publishingOffset
```
  - samplingOffset
```
protected Duration samplingOffset
```
  - writers
```
protected Map<String,PubSubUdpUadpDataSetWriterConf> writers
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - addOrReplaceWriter
```
public PubSubUdpUadpWriterGroupConf.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<PubSubUdpUadpWriterGroupConf.Builder>
  - 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()
```
  - getDataSetOrdering
```
public DataSetOrderingType getDataSetOrdering()
```
  - getGroupVersion
```
public UnsignedInteger getGroupVersion()
```
  - getMessageContentMask
```
public UadpNetworkMessageContentMask getMessageContentMask()
```
  - getPublishingOffset
```
public PubSubPublishingOffsets getPublishingOffset()
```
  - getSamplingOffset
```
public Duration getSamplingOffset()
```
  - getWriters
```
public Map<String,PubSubUdpUadpDataSetWriterConf> getWriters()
```
  - setMaxNetworkMessageSize
```
public PubSubUdpUadpWriterGroupConf.Builder setMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getMaxNetworkMessageSize(). Returns itself for method chaining.
    
    Specified by:
    
    setMaxNetworkMessageSize in interface PubSubGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setName
```
public PubSubUdpUadpWriterGroupConf.Builder setName(String name)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setSecurityConf
```
public PubSubUdpUadpWriterGroupConf.Builder setSecurityConf(PubSubSecurityConf securityConf)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getSecurityConf(). Returns itself for method chaining.
    
    Specified by:
    
    setSecurityConf in interface PubSubGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setEnabled
```
public PubSubUdpUadpWriterGroupConf.Builder setEnabled(Boolean enabled)
```
    Set the value for PubSubUdpUadpWriterGroupConf#getEnabled(). Returns itself for method chaining.
    
    Specified by:
    
    setEnabled in interface PubSubGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setKeepAliveTime
```
public PubSubUdpUadpWriterGroupConf.Builder setKeepAliveTime(Duration keepAliveTime)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getKeepAliveTime(). Returns itself for method chaining.
    
    Specified by:
    
    setKeepAliveTime in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - addLocaleIds
```
public PubSubUdpUadpWriterGroupConf.Builder addLocaleIds(String localeIds)
```
    Adds the value as an element for PubSubUdpUadpWriterGroupConf.getLocaleIds(). Returns itself for method chaining.
    
    Specified by:
    
    addLocaleIds in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setPriority
```
public PubSubUdpUadpWriterGroupConf.Builder setPriority(UnsignedByte priority)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getPriority(). Returns itself for method chaining.
    
    Specified by:
    
    setPriority in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setPublishingInterval
```
public PubSubUdpUadpWriterGroupConf.Builder setPublishingInterval(Duration publishingInterval)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getPublishingInterval(). Returns itself for method chaining.
    
    Specified by:
    
    setPublishingInterval in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setWriterGroupId
```
public PubSubUdpUadpWriterGroupConf.Builder setWriterGroupId(UnsignedShort writerGroupId)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getWriterGroupId(). Returns itself for method chaining.
    
    Specified by:
    
    setWriterGroupId in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setDataSetOrdering
```
public PubSubUdpUadpWriterGroupConf.Builder setDataSetOrdering(DataSetOrderingType dataSetOrdering)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getDataSetOrdering(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetOrdering in interface PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setGroupVersion
```
public PubSubUdpUadpWriterGroupConf.Builder setGroupVersion(UnsignedInteger groupVersion)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getGroupVersion(). Returns itself for method chaining.
    
    Specified by:
    
    setGroupVersion in interface PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setMessageContentMask
```
public PubSubUdpUadpWriterGroupConf.Builder setMessageContentMask(UadpNetworkMessageContentMask messageContentMask)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getMessageContentMask(). Returns itself for method chaining.
    
    Specified by:
    
    setMessageContentMask in interface PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setPublishingOffset
```
public PubSubUdpUadpWriterGroupConf.Builder setPublishingOffset(PubSubPublishingOffsets publishingOffset)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getPublishingOffset(). Returns itself for method chaining.
    
    Specified by:
    
    setPublishingOffset in interface PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - setSamplingOffset
```
public PubSubUdpUadpWriterGroupConf.Builder setSamplingOffset(Duration samplingOffset)
```
    Set the value for PubSubUdpUadpWriterGroupConf.getSamplingOffset(). Returns itself for method chaining.
    
    Specified by:
    
    setSamplingOffset in interface PubSubUadpWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - addOrReplaceWriter
```
public PubSubUdpUadpWriterGroupConf.Builder addOrReplaceWriter(PubSubUdpUadpDataSetWriterConf value)
```
    Adds a Writer to the conf or replaces any existing Writer one with the same PubSubUdpUadpDataSetWriterConf.getName().
  - build
```
public PubSubUdpUadpWriterGroupConf build()
```
    Returns an instance of PubSubUdpUadpWriterGroupConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
    
    Specified by:
    
    build in interface PubSubWriterGroupConf.Builder<PubSubUdpUadpWriterGroupConf.Builder>
  - removeWriter
```
public PubSubUdpUadpWriterGroupConf.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<PubSubUdpUadpWriterGroupConf.Builder>

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

maxNetworkMessageSize

name

securityConf

enabled

keepAliveTime

localeIds

priority

publishingInterval

writerGroupId

dataSetOrdering

groupVersion

messageContentMask

publishingOffset

samplingOffset

writers

Constructor Detail

Builder

Method Detail

addOrReplaceWriter

getTransportProfile

specification

getMaxNetworkMessageSize

getName

getSecurityConf

isEnabled

getKeepAliveTime

getLocaleIds

getPriority

getPublishingInterval

getWriterGroupId

getDataSetOrdering

getGroupVersion

getMessageContentMask

getPublishingOffset

getSamplingOffset

getWriters

setMaxNetworkMessageSize

setName

setSecurityConf

setEnabled

setKeepAliveTime

addLocaleIds

setPriority

setPublishingInterval

setWriterGroupId

setDataSetOrdering

setGroupVersion

setMessageContentMask

setPublishingOffset

setSamplingOffset

addOrReplaceWriter

build

removeWriter