Class Payload.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Payload.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<Payload.Builder>
io.temporal.api.common.v1.Payload.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PayloadOrBuilder, Cloneable
Enclosing class:
Payload
public static final class Payload.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Payload.Builder> 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

  • Method Details

    • 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.Builder<Payload.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Payload.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Payload.Builder>

    • clear

      public Payload.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<Payload.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<Payload.Builder>

    • getDefaultInstanceForType

      public Payload getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public Payload.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<Payload.Builder>

    • setField

      public Payload.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<Payload.Builder>

    • clearField

      public Payload.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<Payload.Builder>

    • clearOneof

      public Payload.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<Payload.Builder>

    • setRepeatedField

      public Payload.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<Payload.Builder>

    • addRepeatedField

      public Payload.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<Payload.Builder>

    • mergeFrom

      public Payload.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<Payload.Builder>

    • mergeFrom

      public Payload.Builder mergeFrom(Payload other)

    • isInitialized

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

    • mergeFrom

      public Payload.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<Payload.Builder>
      Throws:
      IOException

    • 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

    • clearMetadata

      public Payload.Builder clearMetadata()

    • removeMetadata

      public Payload.Builder removeMetadata(String key)
      map<string, bytes> metadata = 1;

    • getMutableMetadata

      @Deprecated public Map<String,com.google.protobuf.ByteString> getMutableMetadata()
      Deprecated.
      Use alternate mutation accessors instead.

    • putMetadata

      public Payload.Builder putMetadata(String key, com.google.protobuf.ByteString value)
      map<string, bytes> metadata = 1;

    • putAllMetadata

      public Payload.Builder putAllMetadata(Map<String,com.google.protobuf.ByteString> values)
      map<string, bytes> metadata = 1;

    • getData

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

    • setData

      public Payload.Builder setData(com.google.protobuf.ByteString value)
      bytes data = 2;
      Parameters:
      value - The data to set.
      Returns:
      This builder for chaining.

    • clearData

      public Payload.Builder clearData()
      bytes data = 2;
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setExternalPayloads

      public Payload.Builder setExternalPayloads(int index, Payload.ExternalPayloadDetails value)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • setExternalPayloads

      public Payload.Builder setExternalPayloads(int index, Payload.ExternalPayloadDetails.Builder builderForValue)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addExternalPayloads

      public Payload.Builder addExternalPayloads(Payload.ExternalPayloadDetails value)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addExternalPayloads

      public Payload.Builder addExternalPayloads(int index, Payload.ExternalPayloadDetails value)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addExternalPayloads

      public Payload.Builder addExternalPayloads(Payload.ExternalPayloadDetails.Builder builderForValue)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addExternalPayloads

      public Payload.Builder addExternalPayloads(int index, Payload.ExternalPayloadDetails.Builder builderForValue)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addAllExternalPayloads

      public Payload.Builder addAllExternalPayloads(Iterable<? extends Payload.ExternalPayloadDetails> values)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • clearExternalPayloads

      public Payload.Builder clearExternalPayloads()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • removeExternalPayloads

      public Payload.Builder removeExternalPayloads(int index)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • getExternalPayloadsBuilder

      public Payload.ExternalPayloadDetails.Builder getExternalPayloadsBuilder(int index)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • 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

    • 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

    • addExternalPayloadsBuilder

      public Payload.ExternalPayloadDetails.Builder addExternalPayloadsBuilder()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • addExternalPayloadsBuilder

      public Payload.ExternalPayloadDetails.Builder addExternalPayloadsBuilder(int index)
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • getExternalPayloadsBuilderList

      public List<Payload.ExternalPayloadDetails.Builder> getExternalPayloadsBuilderList()
       Details about externally stored payloads associated with this payload.
      repeated .temporal.api.common.v1.Payload.ExternalPayloadDetails external_payloads = 3;

    • setUnknownFields

      public final Payload.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<Payload.Builder>

    • mergeUnknownFields

      public final Payload.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<Payload.Builder>