Class AsyncOperation

Namespace

Temporalio.Api.Cloud.Operation.V1

Assembly

Temporalio.dll

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

Inheritance

object

AsyncOperation

Implements

IMessage<AsyncOperation>

IEquatable<AsyncOperation>

IDeepCloneable<AsyncOperation>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

AsyncOperation()

public AsyncOperation()

AsyncOperation(AsyncOperation)

public AsyncOperation(AsyncOperation other)

Parameters

other AsyncOperation

Fields

CheckDurationFieldNumber

Field number for the "check_duration" field.

public const int CheckDurationFieldNumber = 3

Field Value

int

FailureReasonFieldNumber

Field number for the "failure_reason" field.

public const int FailureReasonFieldNumber = 6

Field Value

int

FinishedTimeFieldNumber

Field number for the "finished_time" field.

public const int FinishedTimeFieldNumber = 8

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

OperationInputFieldNumber

Field number for the "operation_input" field.

public const int OperationInputFieldNumber = 5

Field Value

int

OperationTypeFieldNumber

Field number for the "operation_type" field.

public const int OperationTypeFieldNumber = 4

Field Value

int

StartedTimeFieldNumber

Field number for the "started_time" field.

public const int StartedTimeFieldNumber = 7

Field Value

int

StateFieldNumber

Field number for the "state" field.

public const int StateFieldNumber = 2

Field Value

int

Properties

CheckDuration

The recommended duration to check back for an update in the operation's state

public Duration CheckDuration { get; set; }

Property Value

Duration

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FailureReason

If the operation failed, the reason for the failure

public string FailureReason { get; set; }

Property Value

string

FinishedTime

The date and time when the operation completed

public Timestamp FinishedTime { get; set; }

Property Value

Timestamp

Id

The operation id

public string Id { get; set; }

Property Value

string

OperationInput

The input to the operation being performed

(-- api-linter: core::0146::any=disabled --)

public Any OperationInput { get; set; }

Property Value

Any

OperationType

The type of operation being performed

public string OperationType { get; set; }

Property Value

string

Parser

public static MessageParser<AsyncOperation> Parser { get; }

Property Value

MessageParser<AsyncOperation>

StartedTime

The date and time when the operation initiated

public Timestamp StartedTime { get; set; }

Property Value

Timestamp

State

The current state of this operation Possible values are: pending, in_progress, failed, cancelled, fulfilled

public string State { get; set; }

Property Value

string

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

Returns

AsyncOperation

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

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

public bool Equals(AsyncOperation other)

Parameters

other AsyncOperation

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

Merges the given message into this one.

public void MergeFrom(AsyncOperation other)

Parameters

other AsyncOperation

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.