Table of Contents

Class ScheduleActivityTaskCommandAttributes

Namespace
Temporalio.Api.Command.V1
Assembly
Temporalio.dll
public sealed class ScheduleActivityTaskCommandAttributes : IMessage<ScheduleActivityTaskCommandAttributes>, IEquatable<ScheduleActivityTaskCommandAttributes>, IDeepCloneable<ScheduleActivityTaskCommandAttributes>, IBufferMessage, IMessage
Inheritance
ScheduleActivityTaskCommandAttributes
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

ScheduleActivityTaskCommandAttributes() 

public ScheduleActivityTaskCommandAttributes()

ScheduleActivityTaskCommandAttributes(ScheduleActivityTaskCommandAttributes) 

public ScheduleActivityTaskCommandAttributes(ScheduleActivityTaskCommandAttributes other)

Parameters

other ScheduleActivityTaskCommandAttributes

Fields

ActivityIdFieldNumber

Field number for the "activity_id" field.

public const int ActivityIdFieldNumber = 1

Field Value

int

ActivityTypeFieldNumber

Field number for the "activity_type" field.

public const int ActivityTypeFieldNumber = 2

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 5

Field Value

int

HeartbeatTimeoutFieldNumber

Field number for the "heartbeat_timeout" field.

public const int HeartbeatTimeoutFieldNumber = 10

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 6

Field Value

int

RequestEagerExecutionFieldNumber

Field number for the "request_eager_execution" field.

public const int RequestEagerExecutionFieldNumber = 12

Field Value

int

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

public const int RetryPolicyFieldNumber = 11

Field Value

int

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

public const int ScheduleToCloseTimeoutFieldNumber = 7

Field Value

int

ScheduleToStartTimeoutFieldNumber

Field number for the "schedule_to_start_timeout" field.

public const int ScheduleToStartTimeoutFieldNumber = 8

Field Value

int

StartToCloseTimeoutFieldNumber

Field number for the "start_to_close_timeout" field.

public const int StartToCloseTimeoutFieldNumber = 9

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 4

Field Value

int

UseWorkflowBuildIdFieldNumber

Field number for the "use_workflow_build_id" field.

public const int UseWorkflowBuildIdFieldNumber = 13

Field Value

int

Properties

ActivityId 

public string ActivityId { get; set; }

Property Value

string

ActivityType 

public ActivityType ActivityType { get; set; }

Property Value

ActivityType

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header 

public Header Header { get; set; }

Property Value

Header

HeartbeatTimeout

Maximum permitted time between successful worker heartbeats.

public Duration HeartbeatTimeout { get; set; }

Property Value

Duration

Input 

public Payloads Input { get; set; }

Property Value

Payloads

Parser 

public static MessageParser<ScheduleActivityTaskCommandAttributes> Parser { get; }

Property Value

MessageParser<ScheduleActivityTaskCommandAttributes>

RequestEagerExecution

Request to start the activity directly bypassing matching service and worker polling The slot for executing the activity should be reserved when setting this field to true.

public bool RequestEagerExecution { get; set; }

Property Value

bool

RetryPolicy

Activities are provided by a default retry policy which is controlled through the service's dynamic configuration. Retries will be attempted until schedule_to_close_timeout has elapsed. To disable retries set retry_policy.maximum_attempts to 1.

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

ScheduleToCloseTimeout

Indicates how long the caller is willing to wait for activity completion. The "schedule" time is when the activity is initially scheduled, not when the most recent retry is scheduled. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified. When not specified, defaults to the workflow execution 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

ScheduleToStartTimeout

Limits the time an activity task can stay in a task queue before a worker picks it up. The "schedule" time is when the most recent retry is scheduled. This timeout should usually not be set: it's useful in specific scenarios like worker-specific task queues. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout or workflow execution timeout if that is not specified. More info: https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/

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

public Duration ScheduleToStartTimeout { get; set; }

Property Value

Duration

StartToCloseTimeout

Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or schedule_to_close_timeout must be specified.

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

public Duration StartToCloseTimeout { get; set; }

Property Value

Duration

TaskQueue 

public TaskQueue TaskQueue { get; set; }

Property Value

TaskQueue

UseWorkflowBuildId

If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID.

public bool UseWorkflowBuildId { 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 ScheduleActivityTaskCommandAttributes Clone()

Returns

ScheduleActivityTaskCommandAttributes

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

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

public bool Equals(ScheduleActivityTaskCommandAttributes other)

Parameters

other ScheduleActivityTaskCommandAttributes

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

Merges the given message into this one.

public void MergeFrom(ScheduleActivityTaskCommandAttributes other)

Parameters

other ScheduleActivityTaskCommandAttributes

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.