Class GetWorkflowExecutionHistoryRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

GetWorkflowExecutionHistoryRequest

Implements

IMessage<GetWorkflowExecutionHistoryRequest>

IEquatable<GetWorkflowExecutionHistoryRequest>

IDeepCloneable<GetWorkflowExecutionHistoryRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

GetWorkflowExecutionHistoryRequest()

public GetWorkflowExecutionHistoryRequest()

GetWorkflowExecutionHistoryRequest(GetWorkflowExecutionHistoryRequest)

public GetWorkflowExecutionHistoryRequest(GetWorkflowExecutionHistoryRequest other)

Parameters

other GetWorkflowExecutionHistoryRequest

Fields

ExecutionFieldNumber

Field number for the "execution" field.

public const int ExecutionFieldNumber = 2

Field Value

int

HistoryEventFilterTypeFieldNumber

Field number for the "history_event_filter_type" field.

public const int HistoryEventFilterTypeFieldNumber = 6

Field Value

int

MaximumPageSizeFieldNumber

Field number for the "maximum_page_size" field.

public const int MaximumPageSizeFieldNumber = 3

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

NextPageTokenFieldNumber

Field number for the "next_page_token" field.

public const int NextPageTokenFieldNumber = 4

Field Value

int

SkipArchivalFieldNumber

Field number for the "skip_archival" field.

public const int SkipArchivalFieldNumber = 7

Field Value

int

WaitNewEventFieldNumber

Field number for the "wait_new_event" field.

public const int WaitNewEventFieldNumber = 5

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Execution

public WorkflowExecution Execution { get; set; }

Property Value

WorkflowExecution

HistoryEventFilterType

Filter returned events such that they match the specified filter type. Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.

public HistoryEventFilterType HistoryEventFilterType { get; set; }

Property Value

HistoryEventFilterType

MaximumPageSize

public int MaximumPageSize { get; set; }

Property Value

int

Namespace

public string Namespace { get; set; }

Property Value

string

NextPageToken

If a GetWorkflowExecutionHistoryResponse or a PollWorkflowTaskQueueResponse had one of these, it should be passed here to fetch the next page.

public ByteString NextPageToken { get; set; }

Property Value

ByteString

Parser

public static MessageParser<GetWorkflowExecutionHistoryRequest> Parser { get; }

Property Value

MessageParser<GetWorkflowExecutionHistoryRequest>

SkipArchival

public bool SkipArchival { get; set; }

Property Value

bool

WaitNewEvent

If set to true, the RPC call will not resolve until there is a new event which matches the history_event_filter_type, or a timeout is hit.

public bool WaitNewEvent { get; set; }

Property Value

bool

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

Returns

GetWorkflowExecutionHistoryRequest

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

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

public bool Equals(GetWorkflowExecutionHistoryRequest other)

Parameters

other GetWorkflowExecutionHistoryRequest

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

Merges the given message into this one.

public void MergeFrom(GetWorkflowExecutionHistoryRequest other)

Parameters

other GetWorkflowExecutionHistoryRequest

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.