Class StartActivityExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

StartActivityExecutionRequest

Implements

IMessage<StartActivityExecutionRequest>

IEquatable<StartActivityExecutionRequest>

IDeepCloneable<StartActivityExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StartActivityExecutionRequest()

public StartActivityExecutionRequest()

StartActivityExecutionRequest(StartActivityExecutionRequest)

public StartActivityExecutionRequest(StartActivityExecutionRequest other)

Parameters

other StartActivityExecutionRequest

Fields

ActivityIdFieldNumber

Field number for the "activity_id" field.

public const int ActivityIdFieldNumber = 4

Field Value

int

ActivityTypeFieldNumber

Field number for the "activity_type" field.

public const int ActivityTypeFieldNumber = 5

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 16

Field Value

int

HeartbeatTimeoutFieldNumber

Field number for the "heartbeat_timeout" field.

public const int HeartbeatTimeoutFieldNumber = 10

Field Value

int

IdConflictPolicyFieldNumber

Field number for the "id_conflict_policy" field.

public const int IdConflictPolicyFieldNumber = 14

Field Value

int

IdReusePolicyFieldNumber

Field number for the "id_reuse_policy" field.

public const int IdReusePolicyFieldNumber = 13

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 2

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 12

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

PriorityFieldNumber

Field number for the "priority" field.

public const int PriorityFieldNumber = 18

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 3

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

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 15

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 = 6

Field Value

int

UserMetadataFieldNumber

Field number for the "user_metadata" field.

public const int UserMetadataFieldNumber = 17

Field Value

int

Properties

ActivityId

Identifier for this activity. Required. This identifier should be meaningful in the user's own system. It must be unique among activities in the same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.

public string ActivityId { get; set; }

Property Value

string

ActivityType

The type of the activity, a string that corresponds to a registered activity on a worker.

public ActivityType ActivityType { get; set; }

Property Value

ActivityType

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

Header for context propagation and tracing purposes.

public Header Header { get; set; }

Property Value

Header

HeartbeatTimeout

Maximum permitted time between successful worker heartbeats.

public Duration HeartbeatTimeout { get; set; }

Property Value

Duration

IdConflictPolicy

Defines how to resolve an activity id conflict with a running activity. The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.

public ActivityIdConflictPolicy IdConflictPolicy { get; set; }

Property Value

ActivityIdConflictPolicy

IdReusePolicy

Defines whether to allow re-using the activity id from a previously closed activity. The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.

public ActivityIdReusePolicy IdReusePolicy { get; set; }

Property Value

ActivityIdReusePolicy

Identity

The identity of the client who initiated this request

public string Identity { get; set; }

Property Value

string

Input

Serialized arguments to the activity. These are passed as arguments to the activity function.

public Payloads Input { get; set; }

Property Value

Payloads

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<StartActivityExecutionRequest> Parser { get; }

Property Value

MessageParser<StartActivityExecutionRequest>

Priority

Priority metadata.

public Priority Priority { get; set; }

Property Value

Priority

RequestId

A unique identifier for this start request. Typically UUIDv4.

public string RequestId { get; set; }

Property Value

string

RetryPolicy

The retry policy for the activity. Will never exceed schedule_to_close_timeout.

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

SearchAttributes

Search attributes for indexing.

public SearchAttributes SearchAttributes { get; set; }

Property Value

SearchAttributes

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

Task queue to schedule this activity on.

public TaskQueue TaskQueue { get; set; }

Property Value

TaskQueue

UserMetadata

Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.

public UserMetadata UserMetadata { get; set; }

Property Value

UserMetadata

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

Returns

StartActivityExecutionRequest

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

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

public bool Equals(StartActivityExecutionRequest other)

Parameters

other StartActivityExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(StartActivityExecutionRequest other)

Parameters

other StartActivityExecutionRequest

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.