com.prosysopc.ua.pubsub

Class PubSubMqttJsonDataSetWriterConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubMqttJsonDataSetWriterConf

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubDataSetWriterConf, PubSubJsonDataSetWriterConf, PubSubNamedConf

public final class PubSubMqttJsonDataSetWriterConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubMqttJsonDataSetWriterConf.Builder Builder for PubSubMqttJsonDataSetWriterConf.
static class	PubSubMqttJsonDataSetWriterConf.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

Method Summary

Modifier and Type	Method and Description
static PubSubMqttJsonDataSetWriterConf.Builder	builder() Returns a new PubSubMqttJsonDataSetWriterConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
String	getDataSetName()
UnsignedShort	getDataSetWriterId()
DataSetFieldContentMask	getFieldContentMask()
Map<String,String>	getJsonMessageExtraFields()
UnsignedInteger	getKeyFrameCount()
JsonDataSetMessageContentMask	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.
String	getQueueName() Defines the Broker's queuename for the data.
BrokerTransportQualityOfService	getRequestedDeliveryGuarantee()
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the writer group where this writer is or is to be added.
UnsignedShort	getWriterGroupId()
int	hashCode()
Boolean	isEnabled()
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubMqttJsonDataSetWriterConf.Builder	toBuilder() Returns a new PubSubMqttJsonDataSetWriterConf.Builder that is initialized with the state of this object.
String	toString()
PubSubMqttJsonDataSetWriterConf	withDataSetName(String dataSetName)
PubSubMqttJsonDataSetWriterConf	withDataSetWriterId(UnsignedShort dataSetWriterId)
PubSubMqttJsonDataSetWriterConf	withEnabled(Boolean enabled)
PubSubMqttJsonDataSetWriterConf	withFieldContentMask(DataSetFieldContentMask fieldContentMask)
PubSubMqttJsonDataSetWriterConf	withKeyFrameCount(UnsignedInteger keyFrameCount)
PubSubMqttJsonDataSetWriterConf	withMessageContentMask(JsonDataSetMessageContentMask messageContentMask)
PubSubMqttJsonDataSetWriterConf	withMetaDataQueueName(String metaDataQueueName)
PubSubMqttJsonDataSetWriterConf	withMetaDataUpdateTime(Duration metaDataUpdateTime)
PubSubMqttJsonDataSetWriterConf	withName(String name) Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().
PubSubMqttJsonDataSetWriterConf	withQueueName(String queueName)
PubSubMqttJsonDataSetWriterConf	withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
PubSubMqttJsonDataSetWriterConf	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()

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()

withName

public PubSubMqttJsonDataSetWriterConf withName(String name)

Description copied from interface: PubSubNamedConf

Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().

withMetaDataQueueName

public PubSubMqttJsonDataSetWriterConf withMetaDataQueueName(String metaDataQueueName)

withMetaDataUpdateTime

public PubSubMqttJsonDataSetWriterConf withMetaDataUpdateTime(Duration metaDataUpdateTime)

withQueueName

public PubSubMqttJsonDataSetWriterConf withQueueName(String queueName)

withRequestedDeliveryGuarantee

public PubSubMqttJsonDataSetWriterConf withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)

withDataSetName

public PubSubMqttJsonDataSetWriterConf withDataSetName(String dataSetName)

withDataSetWriterId

public PubSubMqttJsonDataSetWriterConf withDataSetWriterId(UnsignedShort dataSetWriterId)

withFieldContentMask

public PubSubMqttJsonDataSetWriterConf withFieldContentMask(DataSetFieldContentMask fieldContentMask)

withKeyFrameCount

public PubSubMqttJsonDataSetWriterConf withKeyFrameCount(UnsignedInteger keyFrameCount)

withWriterGroupId

public PubSubMqttJsonDataSetWriterConf withWriterGroupId(UnsignedShort writerGroupId)

withEnabled

public PubSubMqttJsonDataSetWriterConf withEnabled(Boolean enabled)

withMessageContentMask

public PubSubMqttJsonDataSetWriterConf withMessageContentMask(JsonDataSetMessageContentMask messageContentMask)

builder

public static PubSubMqttJsonDataSetWriterConf.Builder builder()

Returns a new PubSubMqttJsonDataSetWriterConf.Builder that can be used to construct instances of this class

toBuilder

public PubSubMqttJsonDataSetWriterConf.Builder toBuilder()

Returns a new PubSubMqttJsonDataSetWriterConf.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: PubSubDataSetWriterConf

Returns the TransportProfile (uri) of the writer group where this writer is or is to be added. This defines both the transport and encoding of the writer.

Specified by:

getTransportProfile in interface PubSubDataSetWriterConf