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

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

All Implemented Interfaces:

PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>, PubSubUadpMessageContent.Builder<PubSubUadpDataSetMessage.Builder>

Enclosing class:

PubSubUadpDataSetMessage
```
public static final class PubSubUadpDataSetMessage.Builder
extends Object
implements PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>, PubSubUadpMessageContent.Builder<PubSubUadpDataSetMessage.Builder>
```
Builder for PubSubUadpDataSetMessage.

Field Summary

Fields
Modifier and Type	Field and Description
`protected UUID`	`dataSetClassId`
`protected Map<String,PubSubDataValue>`	`dataSetFields`
`protected PubSubDataSetMessageType`	`dataSetMessageType`
`protected PubSubDataSetMetaDataConf`	`dataSetMetaData`
`protected UnsignedShort`	`dataSetWriterId`
`protected ByteString`	`encoded`
`protected Exception`	`error`
`protected PubSubFieldEncodingType`	`fieldEncodingType`
`protected boolean`	`isValid`
`protected UnsignedInteger`	`majorVersion`
`protected UnsignedShort`	`messageSequenceNumber`
`protected UnsignedInteger`	`minorVersion`
`protected UnsignedShort`	`picoSeconds`
`protected StatusCode`	`status`
`protected DateTime`	`timestamp`

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
`PubSubUadpDataSetMessage`	`build()` Returns an instance of `PubSubUadpDataSetMessage` with the values given to this builder.
`UUID`	`getDataSetClassId()`
`Map<String,PubSubDataValue>`	`getDataSetFields()`
`PubSubDataSetMessageType`	`getDataSetMessageType()`
`PubSubDataSetMetaDataConf`	`getDataSetMetaData()`
`UnsignedShort`	`getDataSetWriterId()`
`ByteString`	`getEncoded()`
`Exception`	`getError()`
`PubSubFieldEncodingType`	`getFieldEncodingType()`
`boolean`	`getIsValid()`
`UnsignedInteger`	`getMajorVersion()`
`UnsignedShort`	`getMessageSequenceNumber()`
`UnsignedInteger`	`getMinorVersion()`
`UnsignedShort`	`getPicoSeconds()`
`StatusCode`	`getStatus()`
`DateTime`	`getTimestamp()`
`PubSubUadpDataSetMessage.Builder`	`putDataSetFields(String key, PubSubDataValue value)` Puts the key-value pair for `PubSubUadpDataSetMessage.getDataSetFields()`.
`PubSubUadpDataSetMessage.Builder`	`setDataSetClassId(UUID dataSetClassId)` Set the value for `PubSubUadpDataSetMessage.getDataSetClassId()`.
`PubSubUadpDataSetMessage.Builder`	`setDataSetMessageType(PubSubDataSetMessageType dataSetMessageType)` Set the value for `PubSubUadpDataSetMessage.getDataSetMessageType()`.
`PubSubUadpDataSetMessage.Builder`	`setDataSetMetaData(PubSubDataSetMetaDataConf dataSetMetaData)` Set the value for `PubSubUadpDataSetMessage.getDataSetMetaData()`.
`PubSubUadpDataSetMessage.Builder`	`setDataSetWriterId(UnsignedShort dataSetWriterId)` Set the value for `PubSubUadpDataSetMessage.getDataSetWriterId()`.
`PubSubUadpDataSetMessage.Builder`	`setEncoded(ByteString encoded)` Set the value for `PubSubUadpDataSetMessage.getEncoded()`.
`PubSubUadpDataSetMessage.Builder`	`setError(Exception error)` Set the value for `PubSubUadpDataSetMessage.getError()`.
`PubSubUadpDataSetMessage.Builder`	`setFieldEncodingType(PubSubFieldEncodingType fieldEncodingType)` Set the value for `PubSubUadpDataSetMessage.getFieldEncodingType()`.
`PubSubUadpDataSetMessage.Builder`	`setIsValid(boolean isValid)` Set the value for `PubSubUadpDataSetMessage#isIsValid()`.
`PubSubUadpDataSetMessage.Builder`	`setMajorVersion(UnsignedInteger majorVersion)` Set the value for `PubSubUadpDataSetMessage.getMajorVersion()`.
`PubSubUadpDataSetMessage.Builder`	`setMessageSequenceNumber(UnsignedShort messageSequenceNumber)` Set the value for `PubSubUadpDataSetMessage.getMessageSequenceNumber()`.
`PubSubUadpDataSetMessage.Builder`	`setMinorVersion(UnsignedInteger minorVersion)` Set the value for `PubSubUadpDataSetMessage.getMinorVersion()`.
`PubSubUadpDataSetMessage.Builder`	`setPicoSeconds(UnsignedShort picoSeconds)` Set the value for `PubSubUadpDataSetMessage.getPicoSeconds()`.
`PubSubUadpDataSetMessage.Builder`	`setStatus(StatusCode status)` Set the value for `PubSubUadpDataSetMessage.getStatus()`.
`PubSubUadpDataSetMessage.Builder`	`setTimestamp(DateTime timestamp)` Set the value for `PubSubUadpDataSetMessage.getTimestamp()`.

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

- Field Detail
  - encoded
```
protected ByteString encoded
```
  - dataSetClassId
```
protected UUID dataSetClassId
```
  - dataSetFields
```
protected Map<String,PubSubDataValue> dataSetFields
```
  - dataSetMessageType
```
protected PubSubDataSetMessageType dataSetMessageType
```
  - dataSetMetaData
```
protected PubSubDataSetMetaDataConf dataSetMetaData
```
  - dataSetWriterId
```
protected UnsignedShort dataSetWriterId
```
  - error
```
protected Exception error
```
  - fieldEncodingType
```
protected PubSubFieldEncodingType fieldEncodingType
```
  - isValid
```
protected boolean isValid
```
  - majorVersion
```
protected UnsignedInteger majorVersion
```
  - minorVersion
```
protected UnsignedInteger minorVersion
```
  - picoSeconds
```
protected UnsignedShort picoSeconds
```
  - status
```
protected StatusCode status
```
  - timestamp
```
protected DateTime timestamp
```
  - messageSequenceNumber
```
protected UnsignedShort messageSequenceNumber
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - getEncoded
```
public ByteString getEncoded()
```
  - getDataSetClassId
```
public UUID getDataSetClassId()
```
  - getDataSetFields
```
public Map<String,PubSubDataValue> getDataSetFields()
```
  - getDataSetMessageType
```
public PubSubDataSetMessageType getDataSetMessageType()
```
  - getDataSetMetaData
```
public PubSubDataSetMetaDataConf getDataSetMetaData()
```
  - getDataSetWriterId
```
public UnsignedShort getDataSetWriterId()
```
  - getError
```
public Exception getError()
```
  - getFieldEncodingType
```
public PubSubFieldEncodingType getFieldEncodingType()
```
  - getIsValid
```
public boolean getIsValid()
```
  - getMajorVersion
```
public UnsignedInteger getMajorVersion()
```
  - getMinorVersion
```
public UnsignedInteger getMinorVersion()
```
  - getPicoSeconds
```
public UnsignedShort getPicoSeconds()
```
  - getStatus
```
public StatusCode getStatus()
```
  - getTimestamp
```
public DateTime getTimestamp()
```
  - getMessageSequenceNumber
```
public UnsignedShort getMessageSequenceNumber()
```
  - setEncoded
```
public PubSubUadpDataSetMessage.Builder setEncoded(ByteString encoded)
```
    Set the value for PubSubUadpDataSetMessage.getEncoded(). Returns itself for method chaining.
    
    Specified by:
    
    setEncoded in interface PubSubUadpMessageContent.Builder<PubSubUadpDataSetMessage.Builder>
  - setDataSetClassId
```
public PubSubUadpDataSetMessage.Builder setDataSetClassId(UUID dataSetClassId)
```
    Set the value for PubSubUadpDataSetMessage.getDataSetClassId(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetClassId in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - putDataSetFields
```
public PubSubUadpDataSetMessage.Builder putDataSetFields(String key,
                                                         PubSubDataValue value)
```
    Puts the key-value pair for PubSubUadpDataSetMessage.getDataSetFields(). Returns itself for method chaining.
    
    Specified by:
    
    putDataSetFields in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setDataSetMessageType
```
public PubSubUadpDataSetMessage.Builder setDataSetMessageType(PubSubDataSetMessageType dataSetMessageType)
```
    Set the value for PubSubUadpDataSetMessage.getDataSetMessageType(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetMessageType in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setDataSetMetaData
```
public PubSubUadpDataSetMessage.Builder setDataSetMetaData(PubSubDataSetMetaDataConf dataSetMetaData)
```
    Set the value for PubSubUadpDataSetMessage.getDataSetMetaData(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetMetaData in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setDataSetWriterId
```
public PubSubUadpDataSetMessage.Builder setDataSetWriterId(UnsignedShort dataSetWriterId)
```
    Set the value for PubSubUadpDataSetMessage.getDataSetWriterId(). Returns itself for method chaining.
    
    Specified by:
    
    setDataSetWriterId in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setError
```
public PubSubUadpDataSetMessage.Builder setError(Exception error)
```
    Set the value for PubSubUadpDataSetMessage.getError(). Returns itself for method chaining.
    
    Specified by:
    
    setError in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setFieldEncodingType
```
public PubSubUadpDataSetMessage.Builder setFieldEncodingType(PubSubFieldEncodingType fieldEncodingType)
```
    Set the value for PubSubUadpDataSetMessage.getFieldEncodingType(). Returns itself for method chaining.
    
    Specified by:
    
    setFieldEncodingType in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setIsValid
```
public PubSubUadpDataSetMessage.Builder setIsValid(boolean isValid)
```
    Set the value for PubSubUadpDataSetMessage#isIsValid(). Returns itself for method chaining.
    
    Specified by:
    
    setIsValid in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setMajorVersion
```
public PubSubUadpDataSetMessage.Builder setMajorVersion(UnsignedInteger majorVersion)
```
    Set the value for PubSubUadpDataSetMessage.getMajorVersion(). Returns itself for method chaining.
    
    Specified by:
    
    setMajorVersion in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setMinorVersion
```
public PubSubUadpDataSetMessage.Builder setMinorVersion(UnsignedInteger minorVersion)
```
    Set the value for PubSubUadpDataSetMessage.getMinorVersion(). Returns itself for method chaining.
    
    Specified by:
    
    setMinorVersion in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setPicoSeconds
```
public PubSubUadpDataSetMessage.Builder setPicoSeconds(UnsignedShort picoSeconds)
```
    Set the value for PubSubUadpDataSetMessage.getPicoSeconds(). Returns itself for method chaining.
    
    Specified by:
    
    setPicoSeconds in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setStatus
```
public PubSubUadpDataSetMessage.Builder setStatus(StatusCode status)
```
    Set the value for PubSubUadpDataSetMessage.getStatus(). Returns itself for method chaining.
    
    Specified by:
    
    setStatus in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setTimestamp
```
public PubSubUadpDataSetMessage.Builder setTimestamp(DateTime timestamp)
```
    Set the value for PubSubUadpDataSetMessage.getTimestamp(). Returns itself for method chaining.
    
    Specified by:
    
    setTimestamp in interface PubSubDataSetMessage.Builder<PubSubUadpDataSetMessage.Builder>
  - setMessageSequenceNumber
```
public PubSubUadpDataSetMessage.Builder setMessageSequenceNumber(UnsignedShort messageSequenceNumber)
```
    Set the value for PubSubUadpDataSetMessage.getMessageSequenceNumber(). Returns itself for method chaining.
  - build
```
public PubSubUadpDataSetMessage build()
```
    Returns an instance of PubSubUadpDataSetMessage with the values given to this builder.

Class PubSubUadpDataSetMessage.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

encoded

dataSetClassId

dataSetFields

dataSetMessageType

dataSetMetaData

dataSetWriterId

error

fieldEncodingType

isValid

majorVersion

minorVersion

picoSeconds

status

timestamp

messageSequenceNumber

Constructor Detail

Builder

Method Detail

getEncoded

getDataSetClassId

getDataSetFields

getDataSetMessageType

getDataSetMetaData

getDataSetWriterId

getError

getFieldEncodingType

getIsValid

getMajorVersion

getMinorVersion

getPicoSeconds

getStatus

getTimestamp

getMessageSequenceNumber

setEncoded

setDataSetClassId

putDataSetFields

setDataSetMessageType

setDataSetMetaData

setDataSetWriterId

setError

setFieldEncodingType

setIsValid

setMajorVersion

setMinorVersion

setPicoSeconds

setStatus

setTimestamp

setMessageSequenceNumber

build