Class ScheduleActivityTaskCommandAttributes

Inheritance

Object

ScheduleActivityTaskCommandAttributes

Implements

Google.Protobuf.IBufferMessage

Namespace: Temporalio.Api.Command.V1

Assembly: Temporalio.dll

Syntax

public sealed class ScheduleActivityTaskCommandAttributes : Google.Protobuf.IMessage<ScheduleActivityTaskCommandAttributes>, Google.Protobuf.IBufferMessage

Constructors

ScheduleActivityTaskCommandAttributes()

Declaration

public ScheduleActivityTaskCommandAttributes()

ScheduleActivityTaskCommandAttributes(ScheduleActivityTaskCommandAttributes)

Declaration

public ScheduleActivityTaskCommandAttributes(ScheduleActivityTaskCommandAttributes other)

Parameters

Type	Name	Description
ScheduleActivityTaskCommandAttributes	other

Fields

ActivityIdFieldNumber

Field number for the "activity_id" field.

Declaration

public const int ActivityIdFieldNumber = null

Field Value

Type	Description
Int32

ActivityTypeFieldNumber

Field number for the "activity_type" field.

Declaration

public const int ActivityTypeFieldNumber = null

Field Value

Type	Description
Int32

HeaderFieldNumber

Field number for the "header" field.

Declaration

public const int HeaderFieldNumber = null

Field Value

Type	Description
Int32

HeartbeatTimeoutFieldNumber

Field number for the "heartbeat_timeout" field.

Declaration

public const int HeartbeatTimeoutFieldNumber = null

Field Value

Type	Description
Int32

InputFieldNumber

Field number for the "input" field.

Declaration

public const int InputFieldNumber = null

Field Value

Type	Description
Int32

RequestEagerExecutionFieldNumber

Field number for the "request_eager_execution" field.

Declaration

public const int RequestEagerExecutionFieldNumber = null

Field Value

Type	Description
Int32

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

Declaration

public const int RetryPolicyFieldNumber = null

Field Value

Type	Description
Int32

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

Declaration

public const int ScheduleToCloseTimeoutFieldNumber = null

Field Value

Type	Description
Int32

ScheduleToStartTimeoutFieldNumber

Field number for the "schedule_to_start_timeout" field.

Declaration

public const int ScheduleToStartTimeoutFieldNumber = null

Field Value

Type	Description
Int32

StartToCloseTimeoutFieldNumber

Field number for the "start_to_close_timeout" field.

Declaration

public const int StartToCloseTimeoutFieldNumber = null

Field Value

Type	Description
Int32

TaskQueueFieldNumber

Field number for the "task_queue" field.

Declaration

public const int TaskQueueFieldNumber = null

Field Value

Type	Description
Int32

Properties

ActivityId

Declaration

public string ActivityId { get; set; }

Property Value

Type	Description
String

ActivityType

Declaration

public ActivityType ActivityType { get; set; }

Property Value

Type	Description
ActivityType

Descriptor

Declaration

public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value

Type	Description
Google.Protobuf.Reflection.MessageDescriptor

Header

Declaration

public Header Header { get; set; }

Property Value

Type	Description
Header

HeartbeatTimeout

Maximum permitted time between successful worker heartbeats.

Declaration

public Google.Protobuf.WellKnownTypes.Duration HeartbeatTimeout { get; set; }

Property Value

Type	Description
Google.Protobuf.WellKnownTypes.Duration

Input

Declaration

public Payloads Input { get; set; }

Property Value

Type	Description
Payloads

Parser

Declaration

public static Google.Protobuf.MessageParser<ScheduleActivityTaskCommandAttributes> Parser { get; }

Property Value

Type	Description
Google.Protobuf.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.

Declaration

public bool RequestEagerExecution { get; set; }

Property Value

Type	Description
Boolean

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.

Declaration

public RetryPolicy RetryPolicy { get; set; }

Property Value

Type	Description
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. --)

Declaration

public Google.Protobuf.WellKnownTypes.Duration ScheduleToCloseTimeout { get; set; }

Property Value

Type	Description
Google.Protobuf.WellKnownTypes.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. --)

Declaration

public Google.Protobuf.WellKnownTypes.Duration ScheduleToStartTimeout { get; set; }

Property Value

Type	Description
Google.Protobuf.WellKnownTypes.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. --)

Declaration

public Google.Protobuf.WellKnownTypes.Duration StartToCloseTimeout { get; set; }

Property Value

Type	Description
Google.Protobuf.WellKnownTypes.Duration

TaskQueue

Declaration

public TaskQueue TaskQueue { get; set; }

Property Value

Type	Description
TaskQueue

Methods

CalculateSize()

Declaration

public int CalculateSize()

Returns

Type	Description
Int32

Clone()

Declaration

public ScheduleActivityTaskCommandAttributes Clone()

Returns

Type	Description
ScheduleActivityTaskCommandAttributes

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
Object	other

Returns

Type	Description
Boolean

Equals(ScheduleActivityTaskCommandAttributes)

Declaration

public bool Equals(ScheduleActivityTaskCommandAttributes other)

Parameters

Type	Name	Description
ScheduleActivityTaskCommandAttributes	other

Returns

Type	Description
Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

MergeFrom(Google.Protobuf.CodedInputStream)

Declaration

public void MergeFrom(Google.Protobuf.CodedInputStream input)

Parameters

Type	Name	Description
Google.Protobuf.CodedInputStream	input

MergeFrom(ScheduleActivityTaskCommandAttributes)

Declaration

public void MergeFrom(ScheduleActivityTaskCommandAttributes other)

Parameters

Type	Name	Description
ScheduleActivityTaskCommandAttributes	other

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

WriteTo(Google.Protobuf.CodedOutputStream)

Declaration

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

Type	Name	Description
Google.Protobuf.CodedOutputStream	output

Implements

Google.Protobuf.IBufferMessage