Class StartOperationRequest

Namespace

Temporalio.Api.Nexus.V1

Assembly

Temporalio.dll

A request to start an operation.

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

Inheritance

object

StartOperationRequest

Implements

IMessage<StartOperationRequest>

IEquatable<StartOperationRequest>

IDeepCloneable<StartOperationRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StartOperationRequest()

public StartOperationRequest()

StartOperationRequest(StartOperationRequest)

public StartOperationRequest(StartOperationRequest other)

Parameters

other StartOperationRequest

Fields

CallbackFieldNumber

Field number for the "callback" field.

public const int CallbackFieldNumber = 4

Field Value

int

CallbackHeaderFieldNumber

Field number for the "callback_header" field.

public const int CallbackHeaderFieldNumber = 6

Field Value

int

OperationFieldNumber

Field number for the "operation" field.

public const int OperationFieldNumber = 2

Field Value

int

PayloadFieldNumber

Field number for the "payload" field.

public const int PayloadFieldNumber = 5

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 3

Field Value

int

ServiceFieldNumber

Field number for the "service" field.

public const int ServiceFieldNumber = 1

Field Value

int

Properties

Callback

Callback URL to call upon completion if the started operation is async.

public string Callback { get; set; }

Property Value

string

CallbackHeader

Header that is expected to be attached to the callback request when the operation completes.

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

Property Value

MapField<string, string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Operation

Type of operation to start.

public string Operation { get; set; }

Property Value

string

Parser

public static MessageParser<StartOperationRequest> Parser { get; }

Property Value

MessageParser<StartOperationRequest>

Payload

Full request body from the incoming HTTP request.

public Payload Payload { get; set; }

Property Value

Payload

RequestId

A request ID that can be used as an idempotentency key.

public string RequestId { get; set; }

Property Value

string

Service

Name of service to start the operation in.

public string Service { 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 StartOperationRequest Clone()

Returns

StartOperationRequest

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

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

public bool Equals(StartOperationRequest other)

Parameters

other StartOperationRequest

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

Merges the given message into this one.

public void MergeFrom(StartOperationRequest other)

Parameters

other StartOperationRequest

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.