Class Payload

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.common.v1.Payload
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PayloadOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:Payload.java.pb.meta") public final class Payload extends com.google.protobuf.GeneratedMessageV3 implements PayloadOrBuilder
 Represents some binary (byte array) data (ex: activity input parameters or workflow result) with
 metadata which describes this binary data (format, encoding, encryption, etc). Serialization
 of the data may be user-defined.
Protobuf type temporal.api.common.v1.Payload
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Payload.Builder
    Represents some binary (byte array) data (ex: activity input parameters or workflow result) with metadata which describes this binary data (format, encoding, encryption, etc).
    static final class 
    Payload.ExternalPayloadDetails
    Describes an externally stored object referenced by this payload.
    static interface 
    Payload.ExternalPayloadDetailsOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATA_FIELD_NUMBER
     
    static final int
    EXTERNAL_PAYLOADS_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    map<string, bytes> metadata = 1;
    boolean
    equals(Object obj)
     
    com.google.protobuf.ByteString
    getData()
    bytes data = 2;
    static Payload
    getDefaultInstance()
     
    Payload
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Payload.ExternalPayloadDetails
    getExternalPayloads(int index)
    Details about externally stored payloads associated with this payload.
    int
    getExternalPayloadsCount()
    Details about externally stored payloads associated with this payload.
    List<Payload.ExternalPayloadDetails>
    getExternalPayloadsList()
    Details about externally stored payloads associated with this payload.
    Payload.ExternalPayloadDetailsOrBuilder
    getExternalPayloadsOrBuilder(int index)
    Details about externally stored payloads associated with this payload.
    List<? extends Payload.ExternalPayloadDetailsOrBuilder>
    getExternalPayloadsOrBuilderList()
    Details about externally stored payloads associated with this payload.
    Map<String,com.google.protobuf.ByteString>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    map<string, bytes> metadata = 1;
    Map<String,com.google.protobuf.ByteString>
    getMetadataMap()
    map<string, bytes> metadata = 1;
    com.google.protobuf.ByteString
    getMetadataOrDefault(String key, com.google.protobuf.ByteString defaultValue)
    map<string, bytes> metadata = 1;
    com.google.protobuf.ByteString
    getMetadataOrThrow(String key)
    map<string, bytes> metadata = 1;
    com.google.protobuf.Parser<Payload>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Payload.Builder
    newBuilder()
     
    static Payload.Builder
    newBuilder(Payload prototype)
     
    Payload.Builder
    newBuilderForType()
     
    protected Payload.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Payload
    parseDelimitedFrom(InputStream input)
     
    static Payload
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Payload
    parseFrom(byte[] data)
     
    static Payload
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Payload
    parseFrom(com.google.protobuf.ByteString data)
     
    static Payload
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Payload
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Payload
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Payload
    parseFrom(InputStream input)
     
    static Payload
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Payload
    parseFrom(ByteBuffer data)
     
    static Payload
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Payload>
    parser()
     
    Payload.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • DATA_FIELD_NUMBER

      public static final int DATA_FIELD_NUMBER
      See Also:

    • EXTERNAL_PAYLOADS_FIELD_NUMBER

      public static final int EXTERNAL_PAYLOADS_FIELD_NUMBER
      See Also:

  • 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: PayloadOrBuilder
      map<string, bytes> metadata = 1;
      Specified by:
      getMetadataCount in interface PayloadOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
      map<string, bytes> metadata = 1;
      Specified by:
      containsMetadata in interface PayloadOrBuilder

    • getMetadata

      @Deprecated public Map<String,com.google.protobuf.ByteString> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface PayloadOrBuilder

    • getMetadataMap

      public Map<String,com.google.protobuf.ByteString> getMetadataMap()
      map<string, bytes> metadata = 1;
      Specified by:
      getMetadataMap in interface PayloadOrBuilder

    • getMetadataOrDefault

      public com.google.protobuf.ByteString getMetadataOrDefault(String key, com.google.protobuf.ByteString defaultValue)
      map<string, bytes> metadata = 1;
      Specified by:
      getMetadataOrDefault in interface PayloadOrBuilder

    • getMetadataOrThrow

      public com.google.protobuf.ByteString getMetadataOrThrow(String key)
      map<string, bytes> metadata = 1;
      Specified by:
      getMetadataOrThrow in interface PayloadOrBuilder

    • getData

      public com.google.protobuf.ByteString getData()
      bytes data = 2;
      Specified by:
      getData in interface PayloadOrBuilder
      Returns:
      The data.

    • getExternalPayloadsList

      public List<Payload.ExternalPayloadDetails> getExternalPayloadsList()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;
      Specified by:
      getExternalPayloadsList in interface PayloadOrBuilder

    • getExternalPayloadsOrBuilderList

      public List<? extends Payload.ExternalPayloadDetailsOrBuilder> getExternalPayloadsOrBuilderList()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;
      Specified by:
      getExternalPayloadsOrBuilderList in interface PayloadOrBuilder

    • getExternalPayloadsCount

      public int getExternalPayloadsCount()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;
      Specified by:
      getExternalPayloadsCount in interface PayloadOrBuilder

    • getExternalPayloads

      public Payload.ExternalPayloadDetails getExternalPayloads(int index)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;
      Specified by:
      getExternalPayloads in interface PayloadOrBuilder

    • getExternalPayloadsOrBuilder

      public Payload.ExternalPayloadDetailsOrBuilder getExternalPayloadsOrBuilder(int index)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;
      Specified by:
      getExternalPayloadsOrBuilder in interface PayloadOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • 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 Payload parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static 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 Payload parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Payload.Builder newBuilder()

    • newBuilder

      public static Payload.Builder newBuilder(Payload prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Payload getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<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 Payload getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder