Interface SparkplugBProto.Payload.MetricOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SparkplugBProto.Payload.Metric
,SparkplugBProto.Payload.Metric.Builder
- Enclosing class:
- SparkplugBProto.Payload
public static interface SparkplugBProto.Payload.MetricOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionlong
getAlias()
Metric alias - tied to name on birth and included in all later DATA messagesboolean
bool boolean_value = 14;
com.google.protobuf.ByteString
Bytes, File.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
int
DataType of the metric/tag valuedouble
double double_value = 13;
.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
float
float float_value = 12;
int
uint32 int_value = 10;
boolean
If this is historical data and should not update real time tagboolean
If this is null - explicitly say so rather than using -1, false, etc for some datatypes.boolean
Tells consuming clients such as MQTT Engine to not store this as a taglong
uint64 long_value = 11;
Metadata for the payloadMetadata for the payloadgetName()
Metric name - should only be included on birthcom.google.protobuf.ByteString
Metric name - should only be included on birthoptional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
string string_value = 15;
com.google.protobuf.ByteString
string string_value = 15;
.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
long
Timestamp associated with data acquisition timeboolean
hasAlias()
Metric alias - tied to name on birth and included in all later DATA messagesboolean
bool boolean_value = 14;
boolean
Bytes, Fileboolean
.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
boolean
DataType of the metric/tag valueboolean
double double_value = 13;
boolean
.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
boolean
float float_value = 12;
boolean
uint32 int_value = 10;
boolean
If this is historical data and should not update real time tagboolean
If this is null - explicitly say so rather than using -1, false, etc for some datatypes.boolean
Tells consuming clients such as MQTT Engine to not store this as a tagboolean
uint64 long_value = 11;
boolean
Metadata for the payloadboolean
hasName()
Metric name - should only be included on birthboolean
optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
boolean
string string_value = 15;
boolean
.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
boolean
Timestamp associated with data acquisition timeMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasName
boolean hasName()Metric name - should only be included on birth
optional string name = 1;
- Returns:
- Whether the name field is set.
-
getName
String getName()Metric name - should only be included on birth
optional string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Metric name - should only be included on birth
optional string name = 1;
- Returns:
- The bytes for name.
-
hasAlias
boolean hasAlias()Metric alias - tied to name on birth and included in all later DATA messages
optional uint64 alias = 2;
- Returns:
- Whether the alias field is set.
-
getAlias
long getAlias()Metric alias - tied to name on birth and included in all later DATA messages
optional uint64 alias = 2;
- Returns:
- The alias.
-
hasTimestamp
boolean hasTimestamp()Timestamp associated with data acquisition time
optional uint64 timestamp = 3;
- Returns:
- Whether the timestamp field is set.
-
getTimestamp
long getTimestamp()Timestamp associated with data acquisition time
optional uint64 timestamp = 3;
- Returns:
- The timestamp.
-
hasDatatype
boolean hasDatatype()DataType of the metric/tag value
optional uint32 datatype = 4;
- Returns:
- Whether the datatype field is set.
-
getDatatype
int getDatatype()DataType of the metric/tag value
optional uint32 datatype = 4;
- Returns:
- The datatype.
-
hasIsHistorical
boolean hasIsHistorical()If this is historical data and should not update real time tag
optional bool is_historical = 5;
- Returns:
- Whether the isHistorical field is set.
-
getIsHistorical
boolean getIsHistorical()If this is historical data and should not update real time tag
optional bool is_historical = 5;
- Returns:
- The isHistorical.
-
hasIsTransient
boolean hasIsTransient()Tells consuming clients such as MQTT Engine to not store this as a tag
optional bool is_transient = 6;
- Returns:
- Whether the isTransient field is set.
-
getIsTransient
boolean getIsTransient()Tells consuming clients such as MQTT Engine to not store this as a tag
optional bool is_transient = 6;
- Returns:
- The isTransient.
-
hasIsNull
boolean hasIsNull()If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
optional bool is_null = 7;
- Returns:
- Whether the isNull field is set.
-
getIsNull
boolean getIsNull()If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
optional bool is_null = 7;
- Returns:
- The isNull.
-
hasMetadata
boolean hasMetadata()Metadata for the payload
optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;
- Returns:
- Whether the metadata field is set.
-
getMetadata
SparkplugBProto.Payload.MetaData getMetadata()Metadata for the payload
optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;
- Returns:
- The metadata.
-
getMetadataOrBuilder
SparkplugBProto.Payload.MetaDataOrBuilder getMetadataOrBuilder()Metadata for the payload
optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;
-
hasProperties
boolean hasProperties()optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
- Returns:
- Whether the properties field is set.
-
getProperties
SparkplugBProto.Payload.PropertySet getProperties()optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
- Returns:
- The properties.
-
getPropertiesOrBuilder
SparkplugBProto.Payload.PropertySetOrBuilder getPropertiesOrBuilder()optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
-
hasIntValue
boolean hasIntValue()uint32 int_value = 10;
- Returns:
- Whether the intValue field is set.
-
getIntValue
int getIntValue()uint32 int_value = 10;
- Returns:
- The intValue.
-
hasLongValue
boolean hasLongValue()uint64 long_value = 11;
- Returns:
- Whether the longValue field is set.
-
getLongValue
long getLongValue()uint64 long_value = 11;
- Returns:
- The longValue.
-
hasFloatValue
boolean hasFloatValue()float float_value = 12;
- Returns:
- Whether the floatValue field is set.
-
getFloatValue
float getFloatValue()float float_value = 12;
- Returns:
- The floatValue.
-
hasDoubleValue
boolean hasDoubleValue()double double_value = 13;
- Returns:
- Whether the doubleValue field is set.
-
getDoubleValue
double getDoubleValue()double double_value = 13;
- Returns:
- The doubleValue.
-
hasBooleanValue
boolean hasBooleanValue()bool boolean_value = 14;
- Returns:
- Whether the booleanValue field is set.
-
getBooleanValue
boolean getBooleanValue()bool boolean_value = 14;
- Returns:
- The booleanValue.
-
hasStringValue
boolean hasStringValue()string string_value = 15;
- Returns:
- Whether the stringValue field is set.
-
getStringValue
String getStringValue()string string_value = 15;
- Returns:
- The stringValue.
-
getStringValueBytes
com.google.protobuf.ByteString getStringValueBytes()string string_value = 15;
- Returns:
- The bytes for stringValue.
-
hasBytesValue
boolean hasBytesValue()Bytes, File
bytes bytes_value = 16;
- Returns:
- Whether the bytesValue field is set.
-
getBytesValue
com.google.protobuf.ByteString getBytesValue()Bytes, File
bytes bytes_value = 16;
- Returns:
- The bytesValue.
-
hasDatasetValue
boolean hasDatasetValue().com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
- Returns:
- Whether the datasetValue field is set.
-
getDatasetValue
SparkplugBProto.Payload.DataSet getDatasetValue().com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
- Returns:
- The datasetValue.
-
getDatasetValueOrBuilder
SparkplugBProto.Payload.DataSetOrBuilder getDatasetValueOrBuilder().com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
-
hasTemplateValue
boolean hasTemplateValue().com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
- Returns:
- Whether the templateValue field is set.
-
getTemplateValue
SparkplugBProto.Payload.Template getTemplateValue().com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
- Returns:
- The templateValue.
-
getTemplateValueOrBuilder
SparkplugBProto.Payload.TemplateOrBuilder getTemplateValueOrBuilder().com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
-
hasExtensionValue
boolean hasExtensionValue().com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
- Returns:
- Whether the extensionValue field is set.
-
getExtensionValue
SparkplugBProto.Payload.Metric.MetricValueExtension getExtensionValue().com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
- Returns:
- The extensionValue.
-
getExtensionValueOrBuilder
SparkplugBProto.Payload.Metric.MetricValueExtensionOrBuilder getExtensionValueOrBuilder().com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
-
getValueCase
SparkplugBProto.Payload.Metric.ValueCase getValueCase()
-