Class NexusOperationScheduledEventAttributes

Namespace

Temporalio.Api.History.V1

Assembly

Temporalio.dll

Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.

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

Inheritance

object

NexusOperationScheduledEventAttributes

Implements

IMessage<NexusOperationScheduledEventAttributes>

IEquatable<NexusOperationScheduledEventAttributes>

IDeepCloneable<NexusOperationScheduledEventAttributes>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

NexusOperationScheduledEventAttributes()

public NexusOperationScheduledEventAttributes()

NexusOperationScheduledEventAttributes(NexusOperationScheduledEventAttributes)

public NexusOperationScheduledEventAttributes(NexusOperationScheduledEventAttributes other)

Parameters

other NexusOperationScheduledEventAttributes

Fields

EndpointFieldNumber

Field number for the "endpoint" field.

public const int EndpointFieldNumber = 1

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 4

Field Value

int

NexusHeaderFieldNumber

Field number for the "nexus_header" field.

public const int NexusHeaderFieldNumber = 6

Field Value

int

OperationFieldNumber

Field number for the "operation" field.

public const int OperationFieldNumber = 3

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 8

Field Value

int

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

public const int ScheduleToCloseTimeoutFieldNumber = 5

Field Value

int

ServiceFieldNumber

Field number for the "service" field.

public const int ServiceFieldNumber = 2

Field Value

int

WorkflowTaskCompletedEventIdFieldNumber

Field number for the "workflow_task_completed_event_id" field.

public const int WorkflowTaskCompletedEventIdFieldNumber = 7

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Endpoint

Endpoint name, must exist in the endpoint registry.

public string Endpoint { get; set; }

Property Value

string

Input

Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload stored in this event.

public Payload Input { get; set; }

Property Value

Payload

NexusHeader

Header to attach to the Nexus request. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.

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

Property Value

MapField<string, string>

Operation

Operation name.

public string Operation { get; set; }

Property Value

string

Parser

public static MessageParser<NexusOperationScheduledEventAttributes> Parser { get; }

Property Value

MessageParser<NexusOperationScheduledEventAttributes>

RequestId

A unique ID generated by the history service upon creation of this event. The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.

public string RequestId { get; set; }

Property Value

string

ScheduleToCloseTimeout

Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

public Duration ScheduleToCloseTimeout { get; set; }

Property Value

Duration

Service

Service name.

public string Service { get; set; }

Property Value

string

WorkflowTaskCompletedEventId

The WORKFLOW_TASK_COMPLETED event that the corresponding ScheduleNexusOperation command was reported with.

public long WorkflowTaskCompletedEventId { get; set; }

Property Value

long

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

Returns

NexusOperationScheduledEventAttributes

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

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

public bool Equals(NexusOperationScheduledEventAttributes other)

Parameters

other NexusOperationScheduledEventAttributes

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

Merges the given message into this one.

public void MergeFrom(NexusOperationScheduledEventAttributes other)

Parameters

other NexusOperationScheduledEventAttributes

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.