Class SparkplugBProto.Payload.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,SparkplugBProto.Payload.Builder>
com.cirruslink.sparkplug.protobuf.SparkplugBProto.Payload.Builder
- All Implemented Interfaces:
SparkplugBProto.PayloadOrBuilder
,com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<SparkplugBProto.Payload>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- SparkplugBProto.Payload
public static final class SparkplugBProto.Payload.Builder
extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,SparkplugBProto.Payload.Builder>
implements SparkplugBProto.PayloadOrBuilder
// Indexes of Data Types // Unknown placeholder for future expansion. Unknown = 0; // Basic Types Int8 = 1; Int16 = 2; Int32 = 3; Int64 = 4; UInt8 = 5; UInt16 = 6; UInt32 = 7; UInt64 = 8; Float = 9; Double = 10; Boolean = 11; String = 12; DateTime = 13; Text = 14; // Additional Metric Types UUID = 15; DataSet = 16; Bytes = 17; File = 18; Template = 19; // Additional PropertyValue Types PropertySet = 20; PropertySetList = 21;Protobuf type
com.cirruslink.sparkplug.protobuf.Payload
-
Method Summary
Modifier and TypeMethodDescriptionaddAllMetrics
(Iterable<? extends SparkplugBProto.Payload.Metric> values) Repeated forever - no limit in Google ProtobufsaddExtension
(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, List<Type>> extension, Type value) addMetrics
(int index, SparkplugBProto.Payload.Metric value) Repeated forever - no limit in Google ProtobufsaddMetrics
(int index, SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google ProtobufsRepeated forever - no limit in Google ProtobufsaddMetrics
(SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google ProtobufsRepeated forever - no limit in Google ProtobufsaddMetricsBuilder
(int index) Repeated forever - no limit in Google ProtobufsaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
To optionally bypass the whole definition aboveclearExtension
(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, T> extension) clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) Repeated forever - no limit in Google ProtobufsclearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) clearSeq()
Sequence numberTimestamp at message sending timeUUID to track message type in terms of schema definitionsclone()
com.google.protobuf.ByteString
getBody()
To optionally bypass the whole definition abovestatic final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getMetrics
(int index) Repeated forever - no limit in Google ProtobufsgetMetricsBuilder
(int index) Repeated forever - no limit in Google ProtobufsRepeated forever - no limit in Google Protobufsint
Repeated forever - no limit in Google ProtobufsRepeated forever - no limit in Google ProtobufsgetMetricsOrBuilder
(int index) Repeated forever - no limit in Google ProtobufsList<? extends SparkplugBProto.Payload.MetricOrBuilder>
Repeated forever - no limit in Google Protobufslong
getSeq()
Sequence numberlong
Timestamp at message sending timegetUuid()
UUID to track message type in terms of schema definitionscom.google.protobuf.ByteString
UUID to track message type in terms of schema definitionsboolean
hasBody()
To optionally bypass the whole definition aboveboolean
hasSeq()
Sequence numberboolean
Timestamp at message sending timeboolean
hasUuid()
UUID to track message type in terms of schema definitionsprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(SparkplugBProto.Payload other) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) removeMetrics
(int index) Repeated forever - no limit in Google ProtobufssetBody
(com.google.protobuf.ByteString value) To optionally bypass the whole definition abovesetExtension
(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, List<Type>> extension, int index, Type value) setExtension
(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, Type> extension, Type value) setMetrics
(int index, SparkplugBProto.Payload.Metric value) Repeated forever - no limit in Google ProtobufssetMetrics
(int index, SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google ProtobufssetRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSeq
(long value) Sequence numbersetTimestamp
(long value) Timestamp at message sending timesetUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) UUID to track message type in terms of schema definitionssetUuidBytes
(com.google.protobuf.ByteString value) UUID to track message type in terms of schema definitionsMethods inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder
addExtension, addExtension, clearExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension, setExtension, setExtension
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getOneofFieldDescriptor, getParentForChildren, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, 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.GeneratedMessageV3.ExtendableMessageOrBuilder
getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
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 classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<SparkplugBProto.Payload>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-
setField
public SparkplugBProto.Payload.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
clearField
public SparkplugBProto.Payload.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
clearOneof
public SparkplugBProto.Payload.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-
setRepeatedField
public SparkplugBProto.Payload.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
addRepeatedField
public SparkplugBProto.Payload.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
setExtension
public <Type> SparkplugBProto.Payload.Builder setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, Type> extension, Type value) - Overrides:
setExtension
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
setExtension
public <Type> SparkplugBProto.Payload.Builder setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, List<Type>> extension, int index, Type value) - Overrides:
setExtension
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
addExtension
public <Type> SparkplugBProto.Payload.Builder addExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, List<Type>> extension, Type value) - Overrides:
addExtension
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
clearExtension
public <T> SparkplugBProto.Payload.Builder clearExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<SparkplugBProto.Payload, T> extension) - Overrides:
clearExtension
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SparkplugBProto.Payload.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.ExtendableBuilder<SparkplugBProto.Payload,
SparkplugBProto.Payload.Builder>
-
mergeFrom
public SparkplugBProto.Payload.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SparkplugBProto.Payload.Builder>
- Throws:
IOException
-
hasTimestamp
public boolean hasTimestamp()Timestamp at message sending time
optional uint64 timestamp = 1;
- Specified by:
hasTimestamp
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- Whether the timestamp field is set.
-
getTimestamp
public long getTimestamp()Timestamp at message sending time
optional uint64 timestamp = 1;
- Specified by:
getTimestamp
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- The timestamp.
-
setTimestamp
Timestamp at message sending time
optional uint64 timestamp = 1;
- Parameters:
value
- The timestamp to set.- Returns:
- This builder for chaining.
-
clearTimestamp
Timestamp at message sending time
optional uint64 timestamp = 1;
- Returns:
- This builder for chaining.
-
getMetricsList
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
- Specified by:
getMetricsList
in interfaceSparkplugBProto.PayloadOrBuilder
-
getMetricsCount
public int getMetricsCount()Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
- Specified by:
getMetricsCount
in interfaceSparkplugBProto.PayloadOrBuilder
-
getMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
- Specified by:
getMetrics
in interfaceSparkplugBProto.PayloadOrBuilder
-
setMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
setMetrics
public SparkplugBProto.Payload.Builder setMetrics(int index, SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addMetrics
public SparkplugBProto.Payload.Builder addMetrics(SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addMetrics
public SparkplugBProto.Payload.Builder addMetrics(int index, SparkplugBProto.Payload.Metric.Builder builderForValue) Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addAllMetrics
public SparkplugBProto.Payload.Builder addAllMetrics(Iterable<? extends SparkplugBProto.Payload.Metric> values) Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
clearMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
removeMetrics
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
getMetricsBuilder
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
getMetricsOrBuilder
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
- Specified by:
getMetricsOrBuilder
in interfaceSparkplugBProto.PayloadOrBuilder
-
getMetricsOrBuilderList
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
- Specified by:
getMetricsOrBuilderList
in interfaceSparkplugBProto.PayloadOrBuilder
-
addMetricsBuilder
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
addMetricsBuilder
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
getMetricsBuilderList
Repeated forever - no limit in Google Protobufs
repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
-
hasSeq
public boolean hasSeq()Sequence number
optional uint64 seq = 3;
- Specified by:
hasSeq
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- Whether the seq field is set.
-
getSeq
public long getSeq()Sequence number
optional uint64 seq = 3;
- Specified by:
getSeq
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- The seq.
-
setSeq
Sequence number
optional uint64 seq = 3;
- Parameters:
value
- The seq to set.- Returns:
- This builder for chaining.
-
clearSeq
Sequence number
optional uint64 seq = 3;
- Returns:
- This builder for chaining.
-
hasUuid
public boolean hasUuid()UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Specified by:
hasUuid
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- Whether the uuid field is set.
-
getUuid
UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Specified by:
getUuid
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- The uuid.
-
getUuidBytes
public com.google.protobuf.ByteString getUuidBytes()UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Specified by:
getUuidBytes
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- The bytes for uuid.
-
setUuid
UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Parameters:
value
- The uuid to set.- Returns:
- This builder for chaining.
-
clearUuid
UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Returns:
- This builder for chaining.
-
setUuidBytes
UUID to track message type in terms of schema definitions
optional string uuid = 4;
- Parameters:
value
- The bytes for uuid to set.- Returns:
- This builder for chaining.
-
hasBody
public boolean hasBody()To optionally bypass the whole definition above
optional bytes body = 5;
- Specified by:
hasBody
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- Whether the body field is set.
-
getBody
public com.google.protobuf.ByteString getBody()To optionally bypass the whole definition above
optional bytes body = 5;
- Specified by:
getBody
in interfaceSparkplugBProto.PayloadOrBuilder
- Returns:
- The body.
-
setBody
To optionally bypass the whole definition above
optional bytes body = 5;
- Parameters:
value
- The body to set.- Returns:
- This builder for chaining.
-
clearBody
To optionally bypass the whole definition above
optional bytes body = 5;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final SparkplugBProto.Payload.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-
mergeUnknownFields
public final SparkplugBProto.Payload.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<SparkplugBProto.Payload.Builder>
-