Class ActivityOptions

Namespace

Temporalio.Api.Activity.V1

Assembly

Temporalio.dll

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

Inheritance

object

ActivityOptions

Implements

IMessage<ActivityOptions>

IEquatable<ActivityOptions>

IDeepCloneable<ActivityOptions>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ActivityOptions()

public ActivityOptions()

ActivityOptions(ActivityOptions)

public ActivityOptions(ActivityOptions other)

Parameters

other ActivityOptions

Fields

HeartbeatTimeoutFieldNumber

Field number for the "heartbeat_timeout" field.

public const int HeartbeatTimeoutFieldNumber = 5

Field Value

int

RetryPolicyFieldNumber

Field number for the "retry_policy" field.

public const int RetryPolicyFieldNumber = 6

Field Value

int

ScheduleToCloseTimeoutFieldNumber

Field number for the "schedule_to_close_timeout" field.

public const int ScheduleToCloseTimeoutFieldNumber = 2

Field Value

int

ScheduleToStartTimeoutFieldNumber

Field number for the "schedule_to_start_timeout" field.

public const int ScheduleToStartTimeoutFieldNumber = 3

Field Value

int

StartToCloseTimeoutFieldNumber

Field number for the "start_to_close_timeout" field.

public const int StartToCloseTimeoutFieldNumber = 4

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HeartbeatTimeout

Maximum permitted time between successful worker heartbeats.

public Duration HeartbeatTimeout { get; set; }

Property Value

Duration

Parser

public static MessageParser<ActivityOptions> Parser { get; }

Property Value

MessageParser<ActivityOptions>

RetryPolicy

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

ScheduleToCloseTimeout

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified.

(-- 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 time an activity task can stay in a task queue before a worker picks it up. 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 not specified.

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

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

Returns

ActivityOptions

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

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

public bool Equals(ActivityOptions other)

Parameters

other ActivityOptions

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

Merges the given message into this one.

public void MergeFrom(ActivityOptions other)

Parameters

other ActivityOptions

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.