PubSubMqttUadpDataSetReaderConf (prosys-opc-ua-sdk-client-server-pubsub 5.8.0-259 API)

java.lang.Object
- com.prosysopc.ua.pubsub.PubSubMqttUadpDataSetReaderConf

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubDataSetReaderConf, PubSubNamedConf, PubSubUadpDataSetReaderConf
```
public final class PubSubMqttUadpDataSetReaderConf
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PubSubMqttUadpDataSetReaderConf.Builder` Builder for `PubSubMqttUadpDataSetReaderConf`.
`static class`	`PubSubMqttUadpDataSetReaderConf.Fields`

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf
PubSubConf.MapKind<T>

Field Summary

Fields
Modifier and Type Field and Description

static PubSubConfSpecification SPECIFICATION

Fields
Modifier and Type	Field and Description
`static PubSubConfSpecification`	`SPECIFICATION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PubSubMqttUadpDataSetReaderConf.Builder`	`builder()` Returns a new `PubSubMqttUadpDataSetReaderConf.Builder` that can be used to construct instances of this class
`boolean`	`equals(Object obj)`
`UUID`	`getDataSetClassId()`
`UnsignedShort`	`getDataSetWriterId()`
`DataSetFieldContentMask`	`getFieldContentMask()`
`UadpDataSetMessageContentMask`	`getMessageContentMask()`
`String`	`getMetaDataQueueName()` Defines the Broker's queuename for the metadata.
`Duration`	`getMetaDataUpdateTime()` Configures how often the Metadata is updated to the `getMetaDataQueueName()`.
`String`	`getName()` Returns the name of the PubSub component.
`PublisherId`	`getPublisherId()`
`String`	`getQueueName()` Defines the Broker's queuename for the data.
`BrokerTransportQualityOfService`	`getRequestedDeliveryGuarantee()`
`PubSubSecurityConf`	`getSecurityConf()`
`Duration`	`getSequenceNumberRetentionDuration()` How long previously received SequenceNumbers are remembered.
`PubSubTargetVariablesConf`	`getSubscribedDataSet()`
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the reader group where this reader is or is to be added.
`UnsignedShort`	`getWriterGroupId()`
`int`	`hashCode()`
`Boolean`	`isEnabled()`
`Boolean`	`isIgnoreMissingMetaData()` If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the UADP message is tried to be decoded (assuming Variant or DataValue style, RawData wont work with this) and fields will be assigned index-based-names by the SDK temporarily (or forever if no metadata arrives).
`PubSubConfSpecification`	`specification()` Returns the specification of this object.
`PubSubMqttUadpDataSetReaderConf.Builder`	`toBuilder()` Returns a new `PubSubMqttUadpDataSetReaderConf.Builder` that is initialized with the state of this object.
`String`	`toString()`
`PubSubMqttUadpDataSetReaderConf`	`withDataSetClassId(UUID dataSetClassId)`
`PubSubMqttUadpDataSetReaderConf`	`withDataSetWriterId(UnsignedShort dataSetWriterId)`
`PubSubMqttUadpDataSetReaderConf`	`withEnabled(Boolean enabled)`
`PubSubMqttUadpDataSetReaderConf`	`withFieldContentMask(DataSetFieldContentMask fieldContentMask)`
`PubSubMqttUadpDataSetReaderConf`	`withIgnoreMissingMetaData(Boolean ignoreMissingMetaData)`
`PubSubMqttUadpDataSetReaderConf`	`withMessageContentMask(UadpDataSetMessageContentMask messageContentMask)`
`PubSubMqttUadpDataSetReaderConf`	`withMetaDataQueueName(String metaDataQueueName)`
`PubSubMqttUadpDataSetReaderConf`	`withMetaDataUpdateTime(Duration metaDataUpdateTime)`
`PubSubMqttUadpDataSetReaderConf`	`withName(String name)` Convenience method for doing `PubSubConf.toBuilder()` + `PubSubNamedConf.Builder.setName(String)` + `PubSubConf.Builder.build()`.
`PubSubMqttUadpDataSetReaderConf`	`withPublisherId(PublisherId publisherId)`
`PubSubMqttUadpDataSetReaderConf`	`withQueueName(String queueName)`
`PubSubMqttUadpDataSetReaderConf`	`withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)`
`PubSubMqttUadpDataSetReaderConf`	`withSecurityConf(PubSubSecurityConf securityConf)`
`PubSubMqttUadpDataSetReaderConf`	`withSequenceNumberRetentionDuration(Duration sequenceNumberRetentionDuration)`
`PubSubMqttUadpDataSetReaderConf`	`withSubscribedDataSet(PubSubTargetVariablesConf subscribedDataSet)`
`PubSubMqttUadpDataSetReaderConf`	`withWriterGroupId(UnsignedShort writerGroupId)`

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

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf
get, get, toMap, with, with, withAll

- Field Detail
  - SPECIFICATION
```
public static final PubSubConfSpecification SPECIFICATION
```
- Method Detail
  - specification
```
public PubSubConfSpecification specification()
```
    Description copied from interface: PubSubConf
    
    Returns the specification of this object. Can be used to dynamically display the fields of the PubSubConf object.
  - getName
```
public String getName()
```
    Returns the name of the PubSub component. This name is unique within some context.
  - getMetaDataQueueName
```
public String getMetaDataQueueName()
```
    Defines the Broker's queuename for the metadata. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.
  - getMetaDataUpdateTime
```
public Duration getMetaDataUpdateTime()
```
    Configures how often the Metadata is updated to the getMetaDataQueueName().
  - getQueueName
```
public String getQueueName()
```
    Defines the Broker's queuename for the data. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.
  - getRequestedDeliveryGuarantee
```
public BrokerTransportQualityOfService getRequestedDeliveryGuarantee()
```
  - getDataSetClassId
```
public UUID getDataSetClassId()
```
  - getDataSetWriterId
```
public UnsignedShort getDataSetWriterId()
```
  - getPublisherId
```
public PublisherId getPublisherId()
```
  - getSecurityConf
```
public PubSubSecurityConf getSecurityConf()
```
  - getSubscribedDataSet
```
public PubSubTargetVariablesConf getSubscribedDataSet()
```
  - getWriterGroupId
```
public UnsignedShort getWriterGroupId()
```
  - isEnabled
```
public Boolean isEnabled()
```
  - getFieldContentMask
```
public DataSetFieldContentMask getFieldContentMask()
```
  - getMessageContentMask
```
public UadpDataSetMessageContentMask getMessageContentMask()
```
  - getSequenceNumberRetentionDuration
```
public Duration getSequenceNumberRetentionDuration()
```
    How long previously received SequenceNumbers are remembered. This is useful if the Reader configuration is wildcard-based i.e. it receives data from multiple Publisher/Writers. By default 10 seconds. If no new message arrives for this duration, the next message arriving for a PublisherId+WriterId combination is treated the same way as-if it were the first seen message from that combination. The sequence number is intended to detect message duplication and out of order receiving, mostly regarding when used with UDP.
  - isIgnoreMissingMetaData
```
public Boolean isIgnoreMissingMetaData()
```
    If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the UADP message is tried to be decoded (assuming Variant or DataValue style, RawData wont work with this) and fields will be assigned index-based-names by the SDK temporarily (or forever if no metadata arrives). If the metadata is found the field names from there are used as mapping keys.
    If this is false the Reader wont process the message if metadata was missing.
  - withName
```
public PubSubMqttUadpDataSetReaderConf withName(String name)
```
    Description copied from interface: PubSubNamedConf
    
    Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().
  - withMetaDataQueueName
```
public PubSubMqttUadpDataSetReaderConf withMetaDataQueueName(String metaDataQueueName)
```
  - withMetaDataUpdateTime
```
public PubSubMqttUadpDataSetReaderConf withMetaDataUpdateTime(Duration metaDataUpdateTime)
```
  - withQueueName
```
public PubSubMqttUadpDataSetReaderConf withQueueName(String queueName)
```
  - withRequestedDeliveryGuarantee
```
public PubSubMqttUadpDataSetReaderConf withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
```
  - withDataSetClassId
```
public PubSubMqttUadpDataSetReaderConf withDataSetClassId(UUID dataSetClassId)
```
  - withDataSetWriterId
```
public PubSubMqttUadpDataSetReaderConf withDataSetWriterId(UnsignedShort dataSetWriterId)
```
  - withPublisherId
```
public PubSubMqttUadpDataSetReaderConf withPublisherId(PublisherId publisherId)
```
  - withSecurityConf
```
public PubSubMqttUadpDataSetReaderConf withSecurityConf(PubSubSecurityConf securityConf)
```
  - withSubscribedDataSet
```
public PubSubMqttUadpDataSetReaderConf withSubscribedDataSet(PubSubTargetVariablesConf subscribedDataSet)
```
  - withWriterGroupId
```
public PubSubMqttUadpDataSetReaderConf withWriterGroupId(UnsignedShort writerGroupId)
```
  - withEnabled
```
public PubSubMqttUadpDataSetReaderConf withEnabled(Boolean enabled)
```
  - withFieldContentMask
```
public PubSubMqttUadpDataSetReaderConf withFieldContentMask(DataSetFieldContentMask fieldContentMask)
```
  - withMessageContentMask
```
public PubSubMqttUadpDataSetReaderConf withMessageContentMask(UadpDataSetMessageContentMask messageContentMask)
```
  - withSequenceNumberRetentionDuration
```
public PubSubMqttUadpDataSetReaderConf withSequenceNumberRetentionDuration(Duration sequenceNumberRetentionDuration)
```
  - withIgnoreMissingMetaData
```
public PubSubMqttUadpDataSetReaderConf withIgnoreMissingMetaData(Boolean ignoreMissingMetaData)
```
  - builder
```
public static PubSubMqttUadpDataSetReaderConf.Builder builder()
```
    Returns a new PubSubMqttUadpDataSetReaderConf.Builder that can be used to construct instances of this class
  - toBuilder
```
public PubSubMqttUadpDataSetReaderConf.Builder toBuilder()
```
    Returns a new PubSubMqttUadpDataSetReaderConf.Builder that is initialized with the state of this object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTransportProfile
```
public final PubSubTransportProfile getTransportProfile()
```
    Description copied from interface: PubSubDataSetReaderConf
    
    Returns the TransportProfile (uri) of the reader group where this reader is or is to be added. This defines both the transport and encoding of the reader.
    
    Specified by:
    
    getTransportProfile in interface PubSubDataSetReaderConf

Class PubSubMqttUadpDataSetReaderConf

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SPECIFICATION

Method Detail

specification

getName

getMetaDataQueueName

getMetaDataUpdateTime

getQueueName

getRequestedDeliveryGuarantee

getDataSetClassId

getDataSetWriterId

getPublisherId

getSecurityConf

getSubscribedDataSet

getWriterGroupId

isEnabled

getFieldContentMask

getMessageContentMask

getSequenceNumberRetentionDuration

isIgnoreMissingMetaData

withName

withMetaDataQueueName

withMetaDataUpdateTime

withQueueName

withRequestedDeliveryGuarantee

withDataSetClassId

withDataSetWriterId

withPublisherId

withSecurityConf

withSubscribedDataSet

withWriterGroupId

withEnabled

withFieldContentMask

withMessageContentMask

withSequenceNumberRetentionDuration

withIgnoreMissingMetaData

builder

toBuilder

equals

hashCode

toString

getTransportProfile