Package com.cirruslink.sparkplug.protobuf

Class SparkplugBProto.Payload.Metric.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

com.cirruslink.sparkplug.protobuf.SparkplugBProto.Payload.Metric.Builder

All Implemented Interfaces:

SparkplugBProto.Payload.MetricOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SparkplugBProto.Payload.Metric

public static final class SparkplugBProto.Payload.Metric.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>
implements SparkplugBProto.Payload.MetricOrBuilder

Protobuf type com.cirruslink.sparkplug.protobuf.Payload.Metric

Method Summary

Modifier and Type	Method	Description
SparkplugBProto.Payload.Metric.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SparkplugBProto.Payload.Metric	build()
SparkplugBProto.Payload.Metric	buildPartial()
SparkplugBProto.Payload.Metric.Builder	clear()
SparkplugBProto.Payload.Metric.Builder	clearAlias()	Metric alias - tied to name on birth and included in all later DATA messages
SparkplugBProto.Payload.Metric.Builder	clearBooleanValue()	bool boolean_value = 14;
SparkplugBProto.Payload.Metric.Builder	clearBytesValue()	Bytes, File
SparkplugBProto.Payload.Metric.Builder	clearDatasetValue()	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.Metric.Builder	clearDatatype()	DataType of the metric/tag value
SparkplugBProto.Payload.Metric.Builder	clearDoubleValue()	double double_value = 13;
SparkplugBProto.Payload.Metric.Builder	clearExtensionValue()	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SparkplugBProto.Payload.Metric.Builder	clearFloatValue()	float float_value = 12;
SparkplugBProto.Payload.Metric.Builder	clearIntValue()	uint32 int_value = 10;
SparkplugBProto.Payload.Metric.Builder	clearIsHistorical()	If this is historical data and should not update real time tag
SparkplugBProto.Payload.Metric.Builder	clearIsNull()	If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
SparkplugBProto.Payload.Metric.Builder	clearIsTransient()	Tells consuming clients such as MQTT Engine to not store this as a tag
SparkplugBProto.Payload.Metric.Builder	clearLongValue()	uint64 long_value = 11;
SparkplugBProto.Payload.Metric.Builder	clearMetadata()	Metadata for the payload
SparkplugBProto.Payload.Metric.Builder	clearName()	Metric name - should only be included on birth
SparkplugBProto.Payload.Metric.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SparkplugBProto.Payload.Metric.Builder	clearProperties()	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.Metric.Builder	clearStringValue()	string string_value = 15;
SparkplugBProto.Payload.Metric.Builder	clearTemplateValue()	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
SparkplugBProto.Payload.Metric.Builder	clearTimestamp()	Timestamp associated with data acquisition time
SparkplugBProto.Payload.Metric.Builder	clearValue()
SparkplugBProto.Payload.Metric.Builder	clone()
long	getAlias()	Metric alias - tied to name on birth and included in all later DATA messages
boolean	getBooleanValue()	bool boolean_value = 14;
com.google.protobuf.ByteString	getBytesValue()	Bytes, File
SparkplugBProto.Payload.DataSet	getDatasetValue()	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.DataSet.Builder	getDatasetValueBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.DataSetOrBuilder	getDatasetValueOrBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
int	getDatatype()	DataType of the metric/tag value
SparkplugBProto.Payload.Metric	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getDoubleValue()	double double_value = 13;
SparkplugBProto.Payload.Metric.MetricValueExtension	getExtensionValue()	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.MetricValueExtension.Builder	getExtensionValueBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.MetricValueExtensionOrBuilder	getExtensionValueOrBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
float	getFloatValue()	float float_value = 12;
int	getIntValue()	uint32 int_value = 10;
boolean	getIsHistorical()	If this is historical data and should not update real time tag
boolean	getIsNull()	If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
boolean	getIsTransient()	Tells consuming clients such as MQTT Engine to not store this as a tag
long	getLongValue()	uint64 long_value = 11;
SparkplugBProto.Payload.MetaData	getMetadata()	Metadata for the payload
SparkplugBProto.Payload.MetaData.Builder	getMetadataBuilder()	Metadata for the payload
SparkplugBProto.Payload.MetaDataOrBuilder	getMetadataOrBuilder()	Metadata for the payload
String	getName()	Metric name - should only be included on birth
com.google.protobuf.ByteString	getNameBytes()	Metric name - should only be included on birth
SparkplugBProto.Payload.PropertySet	getProperties()	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.PropertySet.Builder	getPropertiesBuilder()	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.PropertySetOrBuilder	getPropertiesOrBuilder()	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
String	getStringValue()	string string_value = 15;
com.google.protobuf.ByteString	getStringValueBytes()	string string_value = 15;
SparkplugBProto.Payload.Template	getTemplateValue()	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
SparkplugBProto.Payload.Template.Builder	getTemplateValueBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
SparkplugBProto.Payload.TemplateOrBuilder	getTemplateValueOrBuilder()	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
long	getTimestamp()	Timestamp associated with data acquisition time
SparkplugBProto.Payload.Metric.ValueCase	getValueCase()
boolean	hasAlias()	Metric alias - tied to name on birth and included in all later DATA messages
boolean	hasBooleanValue()	bool boolean_value = 14;
boolean	hasBytesValue()	Bytes, File
boolean	hasDatasetValue()	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
boolean	hasDatatype()	DataType of the metric/tag value
boolean	hasDoubleValue()	double double_value = 13;
boolean	hasExtensionValue()	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
boolean	hasFloatValue()	float float_value = 12;
boolean	hasIntValue()	uint32 int_value = 10;
boolean	hasIsHistorical()	If this is historical data and should not update real time tag
boolean	hasIsNull()	If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
boolean	hasIsTransient()	Tells consuming clients such as MQTT Engine to not store this as a tag
boolean	hasLongValue()	uint64 long_value = 11;
boolean	hasMetadata()	Metadata for the payload
boolean	hasName()	Metric name - should only be included on birth
boolean	hasProperties()	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
boolean	hasStringValue()	string string_value = 15;
boolean	hasTemplateValue()	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
boolean	hasTimestamp()	Timestamp associated with data acquisition time
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
SparkplugBProto.Payload.Metric.Builder	mergeDatasetValue(SparkplugBProto.Payload.DataSet value)	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.Metric.Builder	mergeExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension value)	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.Builder	mergeFrom(SparkplugBProto.Payload.Metric other)
SparkplugBProto.Payload.Metric.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SparkplugBProto.Payload.Metric.Builder	mergeFrom(com.google.protobuf.Message other)
SparkplugBProto.Payload.Metric.Builder	mergeMetadata(SparkplugBProto.Payload.MetaData value)	Metadata for the payload
SparkplugBProto.Payload.Metric.Builder	mergeProperties(SparkplugBProto.Payload.PropertySet value)	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.Metric.Builder	mergeTemplateValue(SparkplugBProto.Payload.Template value)	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
final SparkplugBProto.Payload.Metric.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SparkplugBProto.Payload.Metric.Builder	setAlias(long value)	Metric alias - tied to name on birth and included in all later DATA messages
SparkplugBProto.Payload.Metric.Builder	setBooleanValue(boolean value)	bool boolean_value = 14;
SparkplugBProto.Payload.Metric.Builder	setBytesValue(com.google.protobuf.ByteString value)	Bytes, File
SparkplugBProto.Payload.Metric.Builder	setDatasetValue(SparkplugBProto.Payload.DataSet value)	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.Metric.Builder	setDatasetValue(SparkplugBProto.Payload.DataSet.Builder builderForValue)	.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;
SparkplugBProto.Payload.Metric.Builder	setDatatype(int value)	DataType of the metric/tag value
SparkplugBProto.Payload.Metric.Builder	setDoubleValue(double value)	double double_value = 13;
SparkplugBProto.Payload.Metric.Builder	setExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension value)	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.Builder	setExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension.Builder builderForValue)	.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;
SparkplugBProto.Payload.Metric.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SparkplugBProto.Payload.Metric.Builder	setFloatValue(float value)	float float_value = 12;
SparkplugBProto.Payload.Metric.Builder	setIntValue(int value)	uint32 int_value = 10;
SparkplugBProto.Payload.Metric.Builder	setIsHistorical(boolean value)	If this is historical data and should not update real time tag
SparkplugBProto.Payload.Metric.Builder	setIsNull(boolean value)	If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
SparkplugBProto.Payload.Metric.Builder	setIsTransient(boolean value)	Tells consuming clients such as MQTT Engine to not store this as a tag
SparkplugBProto.Payload.Metric.Builder	setLongValue(long value)	uint64 long_value = 11;
SparkplugBProto.Payload.Metric.Builder	setMetadata(SparkplugBProto.Payload.MetaData value)	Metadata for the payload
SparkplugBProto.Payload.Metric.Builder	setMetadata(SparkplugBProto.Payload.MetaData.Builder builderForValue)	Metadata for the payload
SparkplugBProto.Payload.Metric.Builder	setName(String value)	Metric name - should only be included on birth
SparkplugBProto.Payload.Metric.Builder	setNameBytes(com.google.protobuf.ByteString value)	Metric name - should only be included on birth
SparkplugBProto.Payload.Metric.Builder	setProperties(SparkplugBProto.Payload.PropertySet value)	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.Metric.Builder	setProperties(SparkplugBProto.Payload.PropertySet.Builder builderForValue)	optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;
SparkplugBProto.Payload.Metric.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SparkplugBProto.Payload.Metric.Builder	setStringValue(String value)	string string_value = 15;
SparkplugBProto.Payload.Metric.Builder	setStringValueBytes(com.google.protobuf.ByteString value)	string string_value = 15;
SparkplugBProto.Payload.Metric.Builder	setTemplateValue(SparkplugBProto.Payload.Template value)	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
SparkplugBProto.Payload.Metric.Builder	setTemplateValue(SparkplugBProto.Payload.Template.Builder builderForValue)	.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;
SparkplugBProto.Payload.Metric.Builder	setTimestamp(long value)	Timestamp associated with data acquisition time
final SparkplugBProto.Payload.Metric.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

clear

public SparkplugBProto.Payload.Metric.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

getDefaultInstanceForType

public SparkplugBProto.Payload.Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SparkplugBProto.Payload.Metric build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SparkplugBProto.Payload.Metric buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SparkplugBProto.Payload.Metric.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

setField

public SparkplugBProto.Payload.Metric.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

clearField

public SparkplugBProto.Payload.Metric.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

clearOneof

public SparkplugBProto.Payload.Metric.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

setRepeatedField

public SparkplugBProto.Payload.Metric.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

addRepeatedField

public SparkplugBProto.Payload.Metric.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

mergeFrom

public SparkplugBProto.Payload.Metric.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SparkplugBProto.Payload.Metric.Builder>

mergeFrom

public SparkplugBProto.Payload.Metric.Builder mergeFrom(SparkplugBProto.Payload.Metric other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

mergeFrom

public SparkplugBProto.Payload.Metric.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SparkplugBProto.Payload.Metric.Builder>

Throws:

IOException

getValueCase

public SparkplugBProto.Payload.Metric.ValueCase getValueCase()

Specified by:

getValueCase in interface SparkplugBProto.Payload.MetricOrBuilder

clearValue

public SparkplugBProto.Payload.Metric.Builder clearValue()

hasName

public boolean hasName()

 Metric name - should only be included on birth
 

optional string name = 1;

Specified by:

hasName in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

 Metric name - should only be included on birth
 

optional string name = 1;

Specified by:

getName in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Metric name - should only be included on birth
 

optional string name = 1;

Specified by:

getNameBytes in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The bytes for name.

setName

public SparkplugBProto.Payload.Metric.Builder setName(String value)

 Metric name - should only be included on birth
 

optional string name = 1;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public SparkplugBProto.Payload.Metric.Builder clearName()

 Metric name - should only be included on birth
 

optional string name = 1;

Returns:

This builder for chaining.

setNameBytes

public SparkplugBProto.Payload.Metric.Builder setNameBytes(com.google.protobuf.ByteString value)

 Metric name - should only be included on birth
 

optional string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

hasAlias

public boolean hasAlias()

 Metric alias - tied to name on birth and included in all later DATA messages
 

optional uint64 alias = 2;

Specified by:

hasAlias in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the alias field is set.

getAlias

public long getAlias()

 Metric alias - tied to name on birth and included in all later DATA messages
 

optional uint64 alias = 2;

Specified by:

getAlias in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The alias.

setAlias

public SparkplugBProto.Payload.Metric.Builder setAlias(long value)

 Metric alias - tied to name on birth and included in all later DATA messages
 

optional uint64 alias = 2;

Parameters:

value - The alias to set.

Returns:

This builder for chaining.

clearAlias

public SparkplugBProto.Payload.Metric.Builder clearAlias()

 Metric alias - tied to name on birth and included in all later DATA messages
 

optional uint64 alias = 2;

Returns:

This builder for chaining.

hasTimestamp

public boolean hasTimestamp()

 Timestamp associated with data acquisition time
 

optional uint64 timestamp = 3;

Specified by:

hasTimestamp in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public long getTimestamp()

 Timestamp associated with data acquisition time
 

optional uint64 timestamp = 3;

Specified by:

getTimestamp in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The timestamp.

setTimestamp

public SparkplugBProto.Payload.Metric.Builder setTimestamp(long value)

 Timestamp associated with data acquisition time
 

optional uint64 timestamp = 3;

Parameters:

value - The timestamp to set.

Returns:

This builder for chaining.

clearTimestamp

public SparkplugBProto.Payload.Metric.Builder clearTimestamp()

 Timestamp associated with data acquisition time
 

optional uint64 timestamp = 3;

Returns:

This builder for chaining.

hasDatatype

public boolean hasDatatype()

 DataType of the metric/tag value
 

optional uint32 datatype = 4;

Specified by:

hasDatatype in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the datatype field is set.

getDatatype

public int getDatatype()

 DataType of the metric/tag value
 

optional uint32 datatype = 4;

Specified by:

getDatatype in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The datatype.

setDatatype

public SparkplugBProto.Payload.Metric.Builder setDatatype(int value)

 DataType of the metric/tag value
 

optional uint32 datatype = 4;

Parameters:

value - The datatype to set.

Returns:

This builder for chaining.

clearDatatype

public SparkplugBProto.Payload.Metric.Builder clearDatatype()

 DataType of the metric/tag value
 

optional uint32 datatype = 4;

Returns:

This builder for chaining.

hasIsHistorical

public boolean hasIsHistorical()

 If this is historical data and should not update real time tag
 

optional bool is_historical = 5;

Specified by:

hasIsHistorical in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the isHistorical field is set.

getIsHistorical

public boolean getIsHistorical()

 If this is historical data and should not update real time tag
 

optional bool is_historical = 5;

Specified by:

getIsHistorical in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The isHistorical.

setIsHistorical

public SparkplugBProto.Payload.Metric.Builder setIsHistorical(boolean value)

 If this is historical data and should not update real time tag
 

optional bool is_historical = 5;

Parameters:

value - The isHistorical to set.

Returns:

This builder for chaining.

clearIsHistorical

public SparkplugBProto.Payload.Metric.Builder clearIsHistorical()

 If this is historical data and should not update real time tag
 

optional bool is_historical = 5;

Returns:

This builder for chaining.

hasIsTransient

public boolean hasIsTransient()

 Tells consuming clients such as MQTT Engine to not store this as a tag
 

optional bool is_transient = 6;

Specified by:

hasIsTransient in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the isTransient field is set.

getIsTransient

public boolean getIsTransient()

 Tells consuming clients such as MQTT Engine to not store this as a tag
 

optional bool is_transient = 6;

Specified by:

getIsTransient in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The isTransient.

setIsTransient

public SparkplugBProto.Payload.Metric.Builder setIsTransient(boolean value)

 Tells consuming clients such as MQTT Engine to not store this as a tag
 

optional bool is_transient = 6;

Parameters:

value - The isTransient to set.

Returns:

This builder for chaining.

clearIsTransient

public SparkplugBProto.Payload.Metric.Builder clearIsTransient()

 Tells consuming clients such as MQTT Engine to not store this as a tag
 

optional bool is_transient = 6;

Returns:

This builder for chaining.

hasIsNull

public boolean hasIsNull()

 If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
 

optional bool is_null = 7;

Specified by:

hasIsNull in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the isNull field is set.

getIsNull

public boolean getIsNull()

 If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
 

optional bool is_null = 7;

Specified by:

getIsNull in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The isNull.

setIsNull

public SparkplugBProto.Payload.Metric.Builder setIsNull(boolean value)

 If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
 

optional bool is_null = 7;

Parameters:

value - The isNull to set.

Returns:

This builder for chaining.

clearIsNull

public SparkplugBProto.Payload.Metric.Builder clearIsNull()

 If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
 

optional bool is_null = 7;

Returns:

This builder for chaining.

hasMetadata

public boolean hasMetadata()

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

Specified by:

hasMetadata in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the metadata field is set.

getMetadata

public SparkplugBProto.Payload.MetaData getMetadata()

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

Specified by:

getMetadata in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The metadata.

setMetadata

public SparkplugBProto.Payload.Metric.Builder setMetadata(SparkplugBProto.Payload.MetaData value)

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

setMetadata

public SparkplugBProto.Payload.Metric.Builder setMetadata(SparkplugBProto.Payload.MetaData.Builder builderForValue)

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

mergeMetadata

public SparkplugBProto.Payload.Metric.Builder mergeMetadata(SparkplugBProto.Payload.MetaData value)

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

clearMetadata

public SparkplugBProto.Payload.Metric.Builder clearMetadata()

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

getMetadataBuilder

public SparkplugBProto.Payload.MetaData.Builder getMetadataBuilder()

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

getMetadataOrBuilder

public SparkplugBProto.Payload.MetaDataOrBuilder getMetadataOrBuilder()

 Metadata for the payload
 

optional .com.cirruslink.sparkplug.protobuf.Payload.MetaData metadata = 8;

Specified by:

getMetadataOrBuilder in interface SparkplugBProto.Payload.MetricOrBuilder

hasProperties

public boolean hasProperties()

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

Specified by:

hasProperties in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the properties field is set.

getProperties

public SparkplugBProto.Payload.PropertySet getProperties()

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

Specified by:

getProperties in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The properties.

setProperties

public SparkplugBProto.Payload.Metric.Builder setProperties(SparkplugBProto.Payload.PropertySet value)

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

setProperties

public SparkplugBProto.Payload.Metric.Builder setProperties(SparkplugBProto.Payload.PropertySet.Builder builderForValue)

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

mergeProperties

public SparkplugBProto.Payload.Metric.Builder mergeProperties(SparkplugBProto.Payload.PropertySet value)

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

clearProperties

public SparkplugBProto.Payload.Metric.Builder clearProperties()

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

getPropertiesBuilder

public SparkplugBProto.Payload.PropertySet.Builder getPropertiesBuilder()

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

getPropertiesOrBuilder

public SparkplugBProto.Payload.PropertySetOrBuilder getPropertiesOrBuilder()

optional .com.cirruslink.sparkplug.protobuf.Payload.PropertySet properties = 9;

Specified by:

getPropertiesOrBuilder in interface SparkplugBProto.Payload.MetricOrBuilder

hasIntValue

public boolean hasIntValue()

uint32 int_value = 10;

Specified by:

hasIntValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the intValue field is set.

getIntValue

public int getIntValue()

uint32 int_value = 10;

Specified by:

getIntValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The intValue.

setIntValue

public SparkplugBProto.Payload.Metric.Builder setIntValue(int value)

uint32 int_value = 10;

Parameters:

value - The intValue to set.

Returns:

This builder for chaining.

clearIntValue

public SparkplugBProto.Payload.Metric.Builder clearIntValue()

uint32 int_value = 10;

Returns:

This builder for chaining.

hasLongValue

public boolean hasLongValue()

uint64 long_value = 11;

Specified by:

hasLongValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the longValue field is set.

getLongValue

public long getLongValue()

uint64 long_value = 11;

Specified by:

getLongValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The longValue.

setLongValue

public SparkplugBProto.Payload.Metric.Builder setLongValue(long value)

uint64 long_value = 11;

Parameters:

value - The longValue to set.

Returns:

This builder for chaining.

clearLongValue

public SparkplugBProto.Payload.Metric.Builder clearLongValue()

uint64 long_value = 11;

Returns:

This builder for chaining.

hasFloatValue

public boolean hasFloatValue()

float float_value = 12;

Specified by:

hasFloatValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the floatValue field is set.

getFloatValue

public float getFloatValue()

float float_value = 12;

Specified by:

getFloatValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The floatValue.

setFloatValue

public SparkplugBProto.Payload.Metric.Builder setFloatValue(float value)

float float_value = 12;

Parameters:

value - The floatValue to set.

Returns:

This builder for chaining.

clearFloatValue

public SparkplugBProto.Payload.Metric.Builder clearFloatValue()

float float_value = 12;

Returns:

This builder for chaining.

hasDoubleValue

public boolean hasDoubleValue()

double double_value = 13;

Specified by:

hasDoubleValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the doubleValue field is set.

getDoubleValue

public double getDoubleValue()

double double_value = 13;

Specified by:

getDoubleValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The doubleValue.

setDoubleValue

public SparkplugBProto.Payload.Metric.Builder setDoubleValue(double value)

double double_value = 13;

Parameters:

value - The doubleValue to set.

Returns:

This builder for chaining.

clearDoubleValue

public SparkplugBProto.Payload.Metric.Builder clearDoubleValue()

double double_value = 13;

Returns:

This builder for chaining.

hasBooleanValue

public boolean hasBooleanValue()

bool boolean_value = 14;

Specified by:

hasBooleanValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the booleanValue field is set.

getBooleanValue

public boolean getBooleanValue()

bool boolean_value = 14;

Specified by:

getBooleanValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The booleanValue.

setBooleanValue

public SparkplugBProto.Payload.Metric.Builder setBooleanValue(boolean value)

bool boolean_value = 14;

Parameters:

value - The booleanValue to set.

Returns:

This builder for chaining.

clearBooleanValue

public SparkplugBProto.Payload.Metric.Builder clearBooleanValue()

bool boolean_value = 14;

Returns:

This builder for chaining.

hasStringValue

public boolean hasStringValue()

string string_value = 15;

Specified by:

hasStringValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the stringValue field is set.

getStringValue

public String getStringValue()

string string_value = 15;

Specified by:

getStringValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The stringValue.

getStringValueBytes

public com.google.protobuf.ByteString getStringValueBytes()

string string_value = 15;

Specified by:

getStringValueBytes in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The bytes for stringValue.

setStringValue

public SparkplugBProto.Payload.Metric.Builder setStringValue(String value)

string string_value = 15;

Parameters:

value - The stringValue to set.

Returns:

This builder for chaining.

clearStringValue

public SparkplugBProto.Payload.Metric.Builder clearStringValue()

string string_value = 15;

Returns:

This builder for chaining.

setStringValueBytes

public SparkplugBProto.Payload.Metric.Builder setStringValueBytes(com.google.protobuf.ByteString value)

string string_value = 15;

Parameters:

value - The bytes for stringValue to set.

Returns:

This builder for chaining.

hasBytesValue

public boolean hasBytesValue()

 Bytes, File
 

bytes bytes_value = 16;

Specified by:

hasBytesValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the bytesValue field is set.

getBytesValue

public com.google.protobuf.ByteString getBytesValue()

 Bytes, File
 

bytes bytes_value = 16;

Specified by:

getBytesValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The bytesValue.

setBytesValue

public SparkplugBProto.Payload.Metric.Builder setBytesValue(com.google.protobuf.ByteString value)

 Bytes, File
 

bytes bytes_value = 16;

Parameters:

value - The bytesValue to set.

Returns:

This builder for chaining.

clearBytesValue

public SparkplugBProto.Payload.Metric.Builder clearBytesValue()

 Bytes, File
 

bytes bytes_value = 16;

Returns:

This builder for chaining.

hasDatasetValue

public boolean hasDatasetValue()

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

Specified by:

hasDatasetValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the datasetValue field is set.

getDatasetValue

public SparkplugBProto.Payload.DataSet getDatasetValue()

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

Specified by:

getDatasetValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The datasetValue.

setDatasetValue

public SparkplugBProto.Payload.Metric.Builder setDatasetValue(SparkplugBProto.Payload.DataSet value)

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

setDatasetValue

public SparkplugBProto.Payload.Metric.Builder setDatasetValue(SparkplugBProto.Payload.DataSet.Builder builderForValue)

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

mergeDatasetValue

public SparkplugBProto.Payload.Metric.Builder mergeDatasetValue(SparkplugBProto.Payload.DataSet value)

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

clearDatasetValue

public SparkplugBProto.Payload.Metric.Builder clearDatasetValue()

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

getDatasetValueBuilder

public SparkplugBProto.Payload.DataSet.Builder getDatasetValueBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

getDatasetValueOrBuilder

public SparkplugBProto.Payload.DataSetOrBuilder getDatasetValueOrBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.DataSet dataset_value = 17;

Specified by:

getDatasetValueOrBuilder in interface SparkplugBProto.Payload.MetricOrBuilder

hasTemplateValue

public boolean hasTemplateValue()

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

Specified by:

hasTemplateValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the templateValue field is set.

getTemplateValue

public SparkplugBProto.Payload.Template getTemplateValue()

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

Specified by:

getTemplateValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The templateValue.

setTemplateValue

public SparkplugBProto.Payload.Metric.Builder setTemplateValue(SparkplugBProto.Payload.Template value)

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

setTemplateValue

public SparkplugBProto.Payload.Metric.Builder setTemplateValue(SparkplugBProto.Payload.Template.Builder builderForValue)

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

mergeTemplateValue

public SparkplugBProto.Payload.Metric.Builder mergeTemplateValue(SparkplugBProto.Payload.Template value)

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

clearTemplateValue

public SparkplugBProto.Payload.Metric.Builder clearTemplateValue()

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

getTemplateValueBuilder

public SparkplugBProto.Payload.Template.Builder getTemplateValueBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

getTemplateValueOrBuilder

public SparkplugBProto.Payload.TemplateOrBuilder getTemplateValueOrBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.Template template_value = 18;

Specified by:

getTemplateValueOrBuilder in interface SparkplugBProto.Payload.MetricOrBuilder

hasExtensionValue

public boolean hasExtensionValue()

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

Specified by:

hasExtensionValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

Whether the extensionValue field is set.

getExtensionValue

public SparkplugBProto.Payload.Metric.MetricValueExtension getExtensionValue()

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

Specified by:

getExtensionValue in interface SparkplugBProto.Payload.MetricOrBuilder

Returns:

The extensionValue.

setExtensionValue

public SparkplugBProto.Payload.Metric.Builder setExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension value)

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

setExtensionValue

public SparkplugBProto.Payload.Metric.Builder setExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension.Builder builderForValue)

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

mergeExtensionValue

public SparkplugBProto.Payload.Metric.Builder mergeExtensionValue(SparkplugBProto.Payload.Metric.MetricValueExtension value)

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

clearExtensionValue

public SparkplugBProto.Payload.Metric.Builder clearExtensionValue()

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

getExtensionValueBuilder

public SparkplugBProto.Payload.Metric.MetricValueExtension.Builder getExtensionValueBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

getExtensionValueOrBuilder

public SparkplugBProto.Payload.Metric.MetricValueExtensionOrBuilder getExtensionValueOrBuilder()

.com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtension extension_value = 19;

Specified by:

getExtensionValueOrBuilder in interface SparkplugBProto.Payload.MetricOrBuilder

setUnknownFields

public final SparkplugBProto.Payload.Metric.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>

mergeUnknownFields

public final SparkplugBProto.Payload.Metric.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Metric.Builder>