Class PollActivityTaskQueueResponse

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

PollActivityTaskQueueResponse

Implements

IMessage<PollActivityTaskQueueResponse>

IEquatable<PollActivityTaskQueueResponse>

IDeepCloneable<PollActivityTaskQueueResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PollActivityTaskQueueResponse()

public PollActivityTaskQueueResponse()

PollActivityTaskQueueResponse(PollActivityTaskQueueResponse)

public PollActivityTaskQueueResponse(PollActivityTaskQueueResponse other)

Parameters

other PollActivityTaskQueueResponse

Fields

ActivityIdFieldNumber

Field number for the "activity_id" field.

public const int ActivityIdFieldNumber = 6

Field Value

int

ActivityTypeFieldNumber

Field number for the "activity_type" field.

public const int ActivityTypeFieldNumber = 5

Field Value

int

AttemptFieldNumber

Field number for the "attempt" field.

public const int AttemptFieldNumber = 13

Field Value

int

CurrentAttemptScheduledTimeFieldNumber

Field number for the "current_attempt_scheduled_time" field.

public const int CurrentAttemptScheduledTimeFieldNumber = 11

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 7

Field Value

int

HeartbeatDetailsFieldNumber

Field number for the "heartbeat_details" field.

public const int HeartbeatDetailsFieldNumber = 9

Field Value

int

HeartbeatTimeoutFieldNumber

Field number for the "heartbeat_timeout" field.

public const int HeartbeatTimeoutFieldNumber = 16

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 8

Field Value

int

PollerScalingDecisionFieldNumber

Field number for the "poller_scaling_decision" field.

public const int PollerScalingDecisionFieldNumber = 18

Field Value

int

PriorityFieldNumber

Field number for the "priority" field.

public const int PriorityFieldNumber = 19

Field Value

int

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

public const int RetryPolicyFieldNumber = 17

Field Value

int

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

public const int ScheduleToCloseTimeoutFieldNumber = 14

Field Value

int

ScheduledTimeFieldNumber

Field number for the "scheduled_time" field.

public const int ScheduledTimeFieldNumber = 10

Field Value

int

StartToCloseTimeoutFieldNumber

Field number for the "start_to_close_timeout" field.

public const int StartToCloseTimeoutFieldNumber = 15

Field Value

int

StartedTimeFieldNumber

Field number for the "started_time" field.

public const int StartedTimeFieldNumber = 12

Field Value

int

TaskTokenFieldNumber

Field number for the "task_token" field.

public const int TaskTokenFieldNumber = 1

Field Value

int

WorkflowExecutionFieldNumber

Field number for the "workflow_execution" field.

public const int WorkflowExecutionFieldNumber = 4

Field Value

int

WorkflowNamespaceFieldNumber

Field number for the "workflow_namespace" field.

public const int WorkflowNamespaceFieldNumber = 2

Field Value

int

WorkflowTypeFieldNumber

Field number for the "workflow_type" field.

public const int WorkflowTypeFieldNumber = 3

Field Value

int

Properties

ActivityId

The autogenerated or user specified identifier of this activity. Can be used to complete the activity via RespondActivityTaskCompletedById. May be re-used as long as the last usage has resolved, but unique IDs for every activity invocation is a good idea.

public string ActivityId { get; set; }

Property Value

string

ActivityType

public ActivityType ActivityType { get; set; }

Property Value

ActivityType

Attempt

Starting at 1, the number of attempts to perform this activity

public int Attempt { get; set; }

Property Value

int

CurrentAttemptScheduledTime

When was this task attempt scheduled

public Timestamp CurrentAttemptScheduledTime { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

Headers specified by the scheduling workflow. Commonly used to propagate contextual info from the workflow to its activities. For example, tracing contexts.

public Header Header { get; set; }

Property Value

Header

HeartbeatDetails

Details of the last heartbeat that was recorded for this activity as of the time this task was delivered.

public Payloads HeartbeatDetails { get; set; }

Property Value

Payloads

HeartbeatTimeout

Window within which the activity must report a heartbeat, or be timed out.

public Duration HeartbeatTimeout { get; set; }

Property Value

Duration

Input

Arguments to the activity invocation

public Payloads Input { get; set; }

Property Value

Payloads

Parser

public static MessageParser<PollActivityTaskQueueResponse> Parser { get; }

Property Value

MessageParser<PollActivityTaskQueueResponse>

PollerScalingDecision

Server-advised information the SDK may use to adjust its poller count.

public PollerScalingDecision PollerScalingDecision { get; set; }

Property Value

PollerScalingDecision

Priority

Priority metadata

public Priority Priority { get; set; }

Property Value

Priority

RetryPolicy

This is the retry policy the service uses which may be different from the one provided (or not) during activity scheduling. The service can override the provided one if some values are not specified or exceed configured system limits.

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

ScheduleToCloseTimeout

First scheduled -> final result reported timeout

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

public Duration ScheduleToCloseTimeout { get; set; }

Property Value

Duration

ScheduledTime

When was this task first scheduled

public Timestamp ScheduledTime { get; set; }

Property Value

Timestamp

StartToCloseTimeout

Current attempt start -> final result reported timeout

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

public Duration StartToCloseTimeout { get; set; }

Property Value

Duration

StartedTime

When was this task started (this attempt)

public Timestamp StartedTime { get; set; }

Property Value

Timestamp

TaskToken

A unique identifier for this task

public ByteString TaskToken { get; set; }

Property Value

ByteString

WorkflowExecution

Execution info of the requesting workflow

public WorkflowExecution WorkflowExecution { get; set; }

Property Value

WorkflowExecution

WorkflowNamespace

The namespace the workflow which requested this activity lives in

public string WorkflowNamespace { get; set; }

Property Value

string

WorkflowType

Type of the requesting workflow

public WorkflowType WorkflowType { get; set; }

Property Value

WorkflowType

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

Returns

PollActivityTaskQueueResponse

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

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

public bool Equals(PollActivityTaskQueueResponse other)

Parameters

other PollActivityTaskQueueResponse

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

Merges the given message into this one.

public void MergeFrom(PollActivityTaskQueueResponse other)

Parameters

other PollActivityTaskQueueResponse

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.