Package com.inductiveautomation.ignition.gateway.storeforward.sinks.info

Record Class DefaultDataSinkInfo

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.storeforward.sinks.info.DefaultDataSinkInfo

Record Components:

description - the localized description for the data sink

status - the current status of the data sink

storeMetric - a Meter that represents the data storage throughput for the data sink

messages - a list of localized messages associated with the data sink

supportedFlavor - the flavor that the data sink supports

identifier - the identifier for the data store

All Implemented Interfaces:

DataSinkInformation

public record DefaultDataSinkInfo(LocalizedString description, SinkStatus status, com.codahale.metrics.Meter storeMetric, List<LocalizedString> messages, PersistentFlavor<?> supportedFlavor, StorageId identifier)
extends Record
implements DataSinkInformation

A record that represents the default data sink information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultDataSinkInfo.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultDataSinkInfo(LocalizedString description, SinkStatus status, com.codahale.metrics.Meter storeMetric, List<LocalizedString> messages, PersistentFlavor<?> supportedFlavor, StorageId identifier)	Creates an instance of a DefaultDataSinkInfo record class.

Method Summary

Modifier and Type	Method	Description
LocalizedString	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static DefaultDataSinkInfo	fromGson(String json)
static DefaultDataSinkInfo	fromJson(String json)
final int	hashCode()	Returns a hash code value for this object.
StorageId	identifier()	Returns the value of the identifier record component.
List<LocalizedString>	messages()	Returns the value of the messages record component.
static DefaultDataSinkInfo.Builder	newBuilder()
static DefaultDataSinkInfo.Builder	newBuilder(DataSinkInformation info)
SinkStatus	status()	Returns the value of the status record component.
com.codahale.metrics.Meter	storeMetric()	Returns the value of the storeMetric record component.
PersistentFlavor<?>	supportedFlavor()	Returns the value of the supportedFlavor record component.
static com.inductiveautomation.ignition.common.gson.JsonObject	toGson(DefaultDataSinkInfo info)
static String	toJson(DefaultDataSinkInfo info)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultDataSinkInfo

public DefaultDataSinkInfo(LocalizedString description,
 SinkStatus status,
 com.codahale.metrics.Meter storeMetric,
 List<LocalizedString> messages,
 PersistentFlavor<?> supportedFlavor,
 StorageId identifier)

Creates an instance of a DefaultDataSinkInfo record class.

Parameters:

description - the value for the description record component

status - the value for the status record component

storeMetric - the value for the storeMetric record component

messages - the value for the messages record component

supportedFlavor - the value for the supportedFlavor record component

identifier - the value for the identifier record component

Method Details

newBuilder

public static DefaultDataSinkInfo.Builder newBuilder()

newBuilder

public static DefaultDataSinkInfo.Builder newBuilder(DataSinkInformation info)

fromGson

public static DefaultDataSinkInfo fromGson(String json)

fromJson

public static DefaultDataSinkInfo fromJson(String json)

toGson

public static com.inductiveautomation.ignition.common.gson.JsonObject toGson(DefaultDataSinkInfo info)

toJson

public static String toJson(DefaultDataSinkInfo info)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

description

public LocalizedString description()

Returns the value of the description record component.

Specified by:

description in interface DataSinkInformation

Returns:

the value of the description record component

status

public SinkStatus status()

Returns the value of the status record component.

Specified by:

status in interface DataSinkInformation

Returns:

the value of the status record component

storeMetric

public com.codahale.metrics.Meter storeMetric()

Returns the value of the storeMetric record component.

Specified by:

storeMetric in interface DataSinkInformation

Returns:

the value of the storeMetric record component

messages

public List<LocalizedString> messages()

Returns the value of the messages record component.

Specified by:

messages in interface DataSinkInformation

Returns:

the value of the messages record component

supportedFlavor

public PersistentFlavor<?> supportedFlavor()

Returns the value of the supportedFlavor record component.

Specified by:

supportedFlavor in interface DataSinkInformation

Returns:

the value of the supportedFlavor record component

identifier

public StorageId identifier()

Returns the value of the identifier record component.

Specified by:

identifier in interface DataSinkInformation

Returns:

the value of the identifier record component