Class ExternalStorageReference

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

ExternalStorageReference identifies a payload stored in an external storage system. It is used as a claim-check token, allowing the actual payload data to be retrieved from the named driver using the provided claim data.

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

Inheritance

object

ExternalStorageReference

Implements

IMessage<ExternalStorageReference>

IEquatable<ExternalStorageReference>

IDeepCloneable<ExternalStorageReference>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ExternalStorageReference()

public ExternalStorageReference()

ExternalStorageReference(ExternalStorageReference)

public ExternalStorageReference(ExternalStorageReference other)

Parameters

other ExternalStorageReference

Fields

ClaimDataFieldNumber

Field number for the "claim_data" field.

public const int ClaimDataFieldNumber = 2

Field Value

int

DriverNameFieldNumber

Field number for the "driver_name" field.

public const int DriverNameFieldNumber = 1

Field Value

int

Properties

ClaimData

Driver-specific key-value pairs that identify and provide access to the stored payload.

public MapField<string, string> ClaimData { get; }

Property Value

MapField<string, string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DriverName

The name of the storage driver responsible for retrieving the payload.

public string DriverName { get; set; }

Property Value

string

Parser

public static MessageParser<ExternalStorageReference> Parser { get; }

Property Value

MessageParser<ExternalStorageReference>

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 ExternalStorageReference Clone()

Returns

ExternalStorageReference

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

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

public bool Equals(ExternalStorageReference other)

Parameters

other ExternalStorageReference

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

Merges the given message into this one.

public void MergeFrom(ExternalStorageReference other)

Parameters

other ExternalStorageReference

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.