Class PendingNexusOperationInfo

Namespace

Temporalio.Api.Workflow.V1

Assembly

Temporalio.dll

PendingNexusOperationInfo contains the state of a pending Nexus operation.

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

Inheritance

object

PendingNexusOperationInfo

Implements

IMessage<PendingNexusOperationInfo>

IEquatable<PendingNexusOperationInfo>

IDeepCloneable<PendingNexusOperationInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PendingNexusOperationInfo()

public PendingNexusOperationInfo()

PendingNexusOperationInfo(PendingNexusOperationInfo)

public PendingNexusOperationInfo(PendingNexusOperationInfo other)

Parameters

other PendingNexusOperationInfo

Fields

AttemptFieldNumber

Field number for the "attempt" field.

public const int AttemptFieldNumber = 8

Field Value

int

CancellationInfoFieldNumber

Field number for the "cancellation_info" field.

public const int CancellationInfoFieldNumber = 12

Field Value

int

EndpointFieldNumber

Field number for the "endpoint" field.

public const int EndpointFieldNumber = 1

Field Value

int

LastAttemptCompleteTimeFieldNumber

Field number for the "last_attempt_complete_time" field.

public const int LastAttemptCompleteTimeFieldNumber = 9

Field Value

int

LastAttemptFailureFieldNumber

Field number for the "last_attempt_failure" field.

public const int LastAttemptFailureFieldNumber = 10

Field Value

int

NextAttemptScheduleTimeFieldNumber

Field number for the "next_attempt_schedule_time" field.

public const int NextAttemptScheduleTimeFieldNumber = 11

Field Value

int

OperationFieldNumber

Field number for the "operation" field.

public const int OperationFieldNumber = 3

Field Value

int

OperationIdFieldNumber

Field number for the "operation_id" field.

public const int OperationIdFieldNumber = 4

Field Value

int

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

public const int ScheduleToCloseTimeoutFieldNumber = 5

Field Value

int

ScheduledEventIdFieldNumber

Field number for the "scheduled_event_id" field.

public const int ScheduledEventIdFieldNumber = 13

Field Value

int

ScheduledTimeFieldNumber

Field number for the "scheduled_time" field.

public const int ScheduledTimeFieldNumber = 6

Field Value

int

ServiceFieldNumber

Field number for the "service" field.

public const int ServiceFieldNumber = 2

Field Value

int

StateFieldNumber

Field number for the "state" field.

public const int StateFieldNumber = 7

Field Value

int

Properties

Attempt

The number of attempts made to deliver the start operation request. This number represents a minimum bound since the attempt is incremented after the request completes.

public int Attempt { get; set; }

Property Value

int

CancellationInfo

public NexusOperationCancellationInfo CancellationInfo { get; set; }

Property Value

NexusOperationCancellationInfo

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Endpoint

Endpoint name. Resolved to a URL via the cluster's endpoint registry.

public string Endpoint { get; set; }

Property Value

string

LastAttemptCompleteTime

The time when the last attempt completed.

public Timestamp LastAttemptCompleteTime { get; set; }

Property Value

Timestamp

LastAttemptFailure

The last attempt's failure, if any.

public Failure LastAttemptFailure { get; set; }

Property Value

Failure

NextAttemptScheduleTime

The time when the next attempt is scheduled.

public Timestamp NextAttemptScheduleTime { get; set; }

Property Value

Timestamp

Operation

Operation name.

public string Operation { get; set; }

Property Value

string

OperationId

Operation ID. Only set for asynchronous operations after a successful StartOperation call.

public string OperationId { get; set; }

Property Value

string

Parser

public static MessageParser<PendingNexusOperationInfo> Parser { get; }

Property Value

MessageParser<PendingNexusOperationInfo>

ScheduleToCloseTimeout

Schedule-to-close timeout for this operation. This is the only timeout settable by a workflow. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

public Duration ScheduleToCloseTimeout { get; set; }

Property Value

Duration

ScheduledEventId

The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the DescribeWorkflowExecution response with workflow history.

public long ScheduledEventId { get; set; }

Property Value

long

ScheduledTime

The time when the operation was scheduled.

public Timestamp ScheduledTime { get; set; }

Property Value

Timestamp

Service

Service name.

public string Service { get; set; }

Property Value

string

State

public PendingNexusOperationState State { get; set; }

Property Value

PendingNexusOperationState

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

Returns

PendingNexusOperationInfo

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

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

public bool Equals(PendingNexusOperationInfo other)

Parameters

other PendingNexusOperationInfo

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

Merges the given message into this one.

public void MergeFrom(PendingNexusOperationInfo other)

Parameters

other PendingNexusOperationInfo

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.