Class OnCompleteRequest

Namespace

Temporalio.Api.NotificationService.V1

Assembly

Temporalio.dll

OnCompleteRequest is the request type to the NotificationService's OnComplete operation, allowing for defining completion handlers for arbitrary operations.

Information about the source operation will be available in the form of a commonpb.Link, which will be available separately from this OnCompleteRequest. e.g. a link to the source standalone Nexus operation would be found in the nexuspb.StartOperationRequest parameter sent to the worker callback. (In addition to this OnCompleteRequest.)

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

Inheritance

object

OnCompleteRequest

Implements

IMessage<OnCompleteRequest>

IEquatable<OnCompleteRequest>

IDeepCloneable<OnCompleteRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

OnCompleteRequest()

public OnCompleteRequest()

OnCompleteRequest(OnCompleteRequest)

public OnCompleteRequest(OnCompleteRequest other)

Parameters

other OnCompleteRequest

Fields

FailureFieldNumber

Field number for the "failure" field.

public const int FailureFieldNumber = 2

Field Value

int

SourceContextFieldNumber

Field number for the "source_context" field.

public const int SourceContextFieldNumber = 3

Field Value

int

SuccessFieldNumber

Field number for the "success" field.

public const int SuccessFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Failure

The operation failed. Includes timeout, cancellation, and application errors.

public Failure Failure { get; set; }

Property Value

Failure

Parser

public static MessageParser<OnCompleteRequest> Parser { get; }

Property Value

MessageParser<OnCompleteRequest>

ResultCase

public OnCompleteRequest.ResultOneofCase ResultCase { get; }

Property Value

OnCompleteRequest.ResultOneofCase

SourceContext

User-supplied data which was added to the source invocation. (As applicable.)

public Payload SourceContext { get; set; }

Property Value

Payload

Success

The operation was successful, and resulted in the given payload.

public Payload Success { get; set; }

Property Value

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.

ClearResult()

public void ClearResult()

Clone()

Creates a deep clone of this object.

public OnCompleteRequest Clone()

Returns

OnCompleteRequest

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

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

public bool Equals(OnCompleteRequest other)

Parameters

other OnCompleteRequest

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

Merges the given message into this one.

public void MergeFrom(OnCompleteRequest other)

Parameters

other OnCompleteRequest

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.