Class Payload

Namespace

Temporalio.Api.Common.V1

Assembly

Temporalio.dll

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.

public sealed class Payload : IMessage<Payload>, IEquatable<Payload>, IDeepCloneable<Payload>, IBufferMessage, IMessage

Inheritance

object

Payload

Implements

IMessage<Payload>

IEquatable<Payload>

IDeepCloneable<Payload>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Payload()

public Payload()

Payload(Payload)

public Payload(Payload other)

Parameters

other Payload

Fields

DataFieldNumber

Field number for the "data" field.

public const int DataFieldNumber = 2

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 1

Field Value

int

Properties

Data

public ByteString Data { get; set; }

Property Value

ByteString

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Metadata

public MapField<string, ByteString> Metadata { get; }

Property Value

MapField<string, ByteString>

Parser

public static MessageParser<Payload> Parser { get; }

Property Value

MessageParser<Payload>

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public Payload Clone()

Returns

Payload

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(Payload)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(Payload other)

Parameters

other Payload

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(Payload)

Merges the given message into this one.

public void MergeFrom(Payload other)

Parameters

other Payload

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.