Package com.cirruslink.sparkplug.protobuf

Class SparkplugBProto.Payload

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.ExtendableMessage<SparkplugBProto.Payload>
com.cirruslink.sparkplug.protobuf.SparkplugBProto.Payload
All Implemented Interfaces:
SparkplugBProto.PayloadOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<SparkplugBProto.Payload>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SparkplugBProto
public static final class SparkplugBProto.Payload extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<SparkplugBProto.Payload> 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
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasTimestamp

      public boolean hasTimestamp()
       Timestamp at message sending time
      optional uint64 timestamp = 1;
      Specified by:
      hasTimestamp in interface SparkplugBProto.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 interface SparkplugBProto.PayloadOrBuilder
      Returns:
      The timestamp.

    • getMetricsList

      public List<SparkplugBProto.Payload.Metric> getMetricsList()
       Repeated forever - no limit in Google Protobufs
      repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
      Specified by:
      getMetricsList in interface SparkplugBProto.PayloadOrBuilder

    • getMetricsOrBuilderList

      public List<? extends SparkplugBProto.Payload.MetricOrBuilder> getMetricsOrBuilderList()
       Repeated forever - no limit in Google Protobufs
      repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
      Specified by:
      getMetricsOrBuilderList in interface SparkplugBProto.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 interface SparkplugBProto.PayloadOrBuilder

    • getMetrics

      public SparkplugBProto.Payload.Metric getMetrics(int index)
       Repeated forever - no limit in Google Protobufs
      repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
      Specified by:
      getMetrics in interface SparkplugBProto.PayloadOrBuilder

    • getMetricsOrBuilder

      public SparkplugBProto.Payload.MetricOrBuilder getMetricsOrBuilder(int index)
       Repeated forever - no limit in Google Protobufs
      repeated .com.cirruslink.sparkplug.protobuf.Payload.Metric metrics = 2;
      Specified by:
      getMetricsOrBuilder in interface SparkplugBProto.PayloadOrBuilder

    • hasSeq

      public boolean hasSeq()
       Sequence number
      optional uint64 seq = 3;
      Specified by:
      hasSeq in interface SparkplugBProto.PayloadOrBuilder
      Returns:
      Whether the seq field is set.

    • getSeq

      public long getSeq()
       Sequence number
      optional uint64 seq = 3;
      Specified by:
      getSeq in interface SparkplugBProto.PayloadOrBuilder
      Returns:
      The seq.

    • hasUuid

      public boolean hasUuid()
       UUID to track message type in terms of schema definitions
      optional string uuid = 4;
      Specified by:
      hasUuid in interface SparkplugBProto.PayloadOrBuilder
      Returns:
      Whether the uuid field is set.

    • getUuid

      public String getUuid()
       UUID to track message type in terms of schema definitions
      optional string uuid = 4;
      Specified by:
      getUuid in interface SparkplugBProto.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 interface SparkplugBProto.PayloadOrBuilder
      Returns:
      The bytes for uuid.

    • hasBody

      public boolean hasBody()
       To optionally bypass the whole definition above
      optional bytes body = 5;
      Specified by:
      hasBody in interface SparkplugBProto.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 interface SparkplugBProto.PayloadOrBuilder
      Returns:
      The body.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableMessage<SparkplugBProto.Payload>

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SparkplugBProto.Payload parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SparkplugBProto.Payload parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SparkplugBProto.Payload parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SparkplugBProto.Payload.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SparkplugBProto.Payload.Builder newBuilder()

    • newBuilder

      public static SparkplugBProto.Payload.Builder newBuilder(SparkplugBProto.Payload prototype)

    • toBuilder

      public SparkplugBProto.Payload.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SparkplugBProto.Payload.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SparkplugBProto.Payload getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SparkplugBProto.Payload> parser()

    • getParserForType

      public com.google.protobuf.Parser<SparkplugBProto.Payload> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public SparkplugBProto.Payload getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<SparkplugBProto.Payload>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder