Class PauseWorkflowExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

Request to pause a workflow execution.

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

Inheritance

object

PauseWorkflowExecutionRequest

Implements

IMessage<PauseWorkflowExecutionRequest>

IEquatable<PauseWorkflowExecutionRequest>

IDeepCloneable<PauseWorkflowExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PauseWorkflowExecutionRequest()

public PauseWorkflowExecutionRequest()

PauseWorkflowExecutionRequest(PauseWorkflowExecutionRequest)

public PauseWorkflowExecutionRequest(PauseWorkflowExecutionRequest other)

Parameters

other PauseWorkflowExecutionRequest

Fields

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 4

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 5

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 6

Field Value

int

RunIdFieldNumber

Field number for the "run_id" field.

public const int RunIdFieldNumber = 3

Field Value

int

WorkflowIdFieldNumber

Field number for the "workflow_id" field.

public const int WorkflowIdFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

The identity of the client who initiated this request.

public string Identity { get; set; }

Property Value

string

Namespace

Namespace of the workflow to pause.

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<PauseWorkflowExecutionRequest> Parser { get; }

Property Value

MessageParser<PauseWorkflowExecutionRequest>

Reason

Reason to pause the workflow execution.

public string Reason { get; set; }

Property Value

string

RequestId

A unique identifier for this pause request for idempotence. Typically UUIDv4.

public string RequestId { get; set; }

Property Value

string

RunId

Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.

public string RunId { get; set; }

Property Value

string

WorkflowId

ID of the workflow execution to be paused. Required.

public string WorkflowId { 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 PauseWorkflowExecutionRequest Clone()

Returns

PauseWorkflowExecutionRequest

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

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

public bool Equals(PauseWorkflowExecutionRequest other)

Parameters

other PauseWorkflowExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(PauseWorkflowExecutionRequest other)

Parameters

other PauseWorkflowExecutionRequest

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.