Class DescribeActivityExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

DescribeActivityExecutionRequest

Implements

IMessage<DescribeActivityExecutionRequest>

IEquatable<DescribeActivityExecutionRequest>

IDeepCloneable<DescribeActivityExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DescribeActivityExecutionRequest()

public DescribeActivityExecutionRequest()

DescribeActivityExecutionRequest(DescribeActivityExecutionRequest)

public DescribeActivityExecutionRequest(DescribeActivityExecutionRequest other)

Parameters

other DescribeActivityExecutionRequest

Fields

ActivityIdFieldNumber

Field number for the "activity_id" field.

public const int ActivityIdFieldNumber = 2

Field Value

int

IncludeInputFieldNumber

Field number for the "include_input" field.

public const int IncludeInputFieldNumber = 4

Field Value

int

IncludeOutcomeFieldNumber

Field number for the "include_outcome" field.

public const int IncludeOutcomeFieldNumber = 5

Field Value

int

LongPollTokenFieldNumber

Field number for the "long_poll_token" field.

public const int LongPollTokenFieldNumber = 6

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

RunIdFieldNumber

Field number for the "run_id" field.

public const int RunIdFieldNumber = 3

Field Value

int

Properties

ActivityId

public string ActivityId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

IncludeInput

Include the input field in the response.

public bool IncludeInput { get; set; }

Property Value

bool

IncludeOutcome

Include the outcome (result/failure) in the response if the activity has completed.

public bool IncludeOutcome { get; set; }

Property Value

bool

LongPollToken

Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that activity state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.

public ByteString LongPollToken { get; set; }

Property Value

ByteString

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<DescribeActivityExecutionRequest> Parser { get; }

Property Value

MessageParser<DescribeActivityExecutionRequest>

RunId

Activity run ID. If empty the request targets the latest run.

public string RunId { 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 DescribeActivityExecutionRequest Clone()

Returns

DescribeActivityExecutionRequest

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

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

public bool Equals(DescribeActivityExecutionRequest other)

Parameters

other DescribeActivityExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(DescribeActivityExecutionRequest other)

Parameters

other DescribeActivityExecutionRequest

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.