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

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

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubGroupConf, PubSubJsonWriterGroupConf<PubSubMqttJsonDataSetWriterConf>, PubSubNamedConf, PubSubWriterGroupConf<PubSubMqttJsonDataSetWriterConf>
```
public final class PubSubMqttJsonWriterGroupConf
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PubSubMqttJsonWriterGroupConf.Builder` Builder for `PubSubMqttJsonWriterGroupConf`.
`static class`	`PubSubMqttJsonWriterGroupConf.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 PubSubMqttJsonWriterGroupConf.Builder`	`builder()` Returns a new `PubSubMqttJsonWriterGroupConf.Builder` that can be used to construct instances of this class
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getJsonHeaderExtraFields()`
`Duration`	`getKeepAliveTime()`
`List<String>`	`getLocaleIds()`
`UnsignedInteger`	`getMaxNetworkMessageSize()`
`JsonNetworkMessageContentMask`	`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 PubSubGroup.
`UnsignedByte`	`getPriority()`
`Duration`	`getPublishingInterval()`
`String`	`getQueueName()` Defines the Broker's queuename for the data.
`BrokerTransportQualityOfService`	`getRequestedDeliveryGuarantee()`
`PubSubSecurityConf`	`getSecurityConf()` Returns configuration related to message security.
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the connection where this group is or is to be added.
`UnsignedShort`	`getWriterGroupId()`
`Map<String,PubSubMqttJsonDataSetWriterConf>`	`getWriters()`
`int`	`hashCode()`
`Boolean`	`isEnabled()` Returns the enabled state of the PubSubGroup.
`PubSubConfSpecification`	`specification()` Returns the specification of this object.
`PubSubMqttJsonWriterGroupConf.Builder`	`toBuilder()` Returns a new `PubSubMqttJsonWriterGroupConf.Builder` that is initialized with the state of this object.
`String`	`toString()`
`PubSubMqttJsonWriterGroupConf`	`withWriterAddedOrReplaced(PubSubMqttJsonDataSetWriterConf conf)` Returns an instance similar to this, but with the Writer given as parameter added or replaced if any existing one had the `PubSubMqttJsonDataSetWriterConf.getName()`.
`PubSubMqttJsonWriterGroupConf`	`withWriterRemoved(String name)` Removes Writer from the conf if there is any with the given name.

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

- 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.
  - 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()
```
  - getMaxNetworkMessageSize
```
public UnsignedInteger getMaxNetworkMessageSize()
```
  - getName
```
public String getName()
```
    Returns the name of the PubSubGroup. The name shall be unique across all reader and writer groups of a PubSubConnection.
  - getSecurityConf
```
public PubSubSecurityConf getSecurityConf()
```
    Returns configuration related to message security.
  - isEnabled
```
public Boolean isEnabled()
```
    Returns the enabled state of the PubSubGroup.
  - 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()
```
  - withWriterRemoved
```
public PubSubMqttJsonWriterGroupConf withWriterRemoved(String name)
```
    Removes Writer from the conf if there is any with the given name.
  - withWriterAddedOrReplaced
```
public PubSubMqttJsonWriterGroupConf withWriterAddedOrReplaced(PubSubMqttJsonDataSetWriterConf conf)
```
    Returns an instance similar to this, but with the Writer given as parameter added or replaced if any existing one had the PubSubMqttJsonDataSetWriterConf.getName().
  - builder
```
public static PubSubMqttJsonWriterGroupConf.Builder builder()
```
    Returns a new PubSubMqttJsonWriterGroupConf.Builder that can be used to construct instances of this class
  - toBuilder
```
public PubSubMqttJsonWriterGroupConf.Builder toBuilder()
```
    Returns a new PubSubMqttJsonWriterGroupConf.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: PubSubGroupConf
    
    Returns the TransportProfile (uri) of the connection where this group is or is to be added. This defines both the transport and encoding of the group.
    
    Specified by:
    
    getTransportProfile in interface PubSubGroupConf

Class PubSubMqttJsonWriterGroupConf

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

getMetaDataQueueName

getMetaDataUpdateTime

getQueueName

getRequestedDeliveryGuarantee

getMaxNetworkMessageSize

getName

getSecurityConf

isEnabled

getKeepAliveTime

getLocaleIds

getPriority

getPublishingInterval

getWriterGroupId

getMessageContentMask

getJsonHeaderExtraFields

getWriters

withWriterRemoved

withWriterAddedOrReplaced

builder

toBuilder

equals

hashCode

toString

getTransportProfile