Class StartActivityOptions.Builder

java.lang.Object

io.temporal.client.StartActivityOptions.Builder

Enclosing class:

StartActivityOptions

public static final class StartActivityOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
StartActivityOptions	build()
StartActivityOptions.Builder	setHeartbeatTimeout(Duration heartbeatTimeout)	Maximum time between heartbeats before the server considers the activity failed.
StartActivityOptions.Builder	setId(String id)	Required.
StartActivityOptions.Builder	setIdConflictPolicy(io.temporal.api.enums.v1.ActivityIdConflictPolicy idConflictPolicy)	Controls behavior when an activity with the same ID is currently running.
StartActivityOptions.Builder	setIdReusePolicy(io.temporal.api.enums.v1.ActivityIdReusePolicy idReusePolicy)	Controls behavior when an activity with the same ID was previously run and is now closed.
StartActivityOptions.Builder	setPriority(Priority priority)	Priority hint for task routing.
StartActivityOptions.Builder	setRetryOptions(RetryOptions retryOptions)	Retry policy.
StartActivityOptions.Builder	setScheduleToCloseTimeout(Duration scheduleToCloseTimeout)	Total time the caller is willing to wait for the activity to complete (including all retries).
StartActivityOptions.Builder	setScheduleToStartTimeout(Duration scheduleToStartTimeout)	Time the activity task may wait in the task queue before a worker picks it up.
StartActivityOptions.Builder	setStartDelay(Duration startDelay)	Time to wait before dispatching the first activity task.
StartActivityOptions.Builder	setStartToCloseTimeout(Duration startToCloseTimeout)	Maximum time for a single attempt.
StartActivityOptions.Builder	setStaticDetails(String staticDetails)	Longer static details for UI display; encoded as a payload in UserMetadata.
StartActivityOptions.Builder	setStaticSummary(String staticSummary)	Short static summary for UI display; encoded as a payload in UserMetadata.
StartActivityOptions.Builder	setTaskQueue(String taskQueue)	Required.
StartActivityOptions.Builder	setTypedSearchAttributes(SearchAttributes typedSearchAttributes)	Typed search attributes to attach to this activity execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setId

public StartActivityOptions.Builder setId(String id)

Required. A unique identifier for this activity in the namespace.

setTaskQueue

public StartActivityOptions.Builder setTaskQueue(String taskQueue)

Required. The task queue that workers will poll for this activity.

setScheduleToCloseTimeout

public StartActivityOptions.Builder setScheduleToCloseTimeout(Duration scheduleToCloseTimeout)

Total time the caller is willing to wait for the activity to complete (including all retries). Either this or setStartToCloseTimeout(Duration) is required.

setScheduleToStartTimeout

public StartActivityOptions.Builder setScheduleToStartTimeout(Duration scheduleToStartTimeout)

Time the activity task may wait in the task queue before a worker picks it up. Non-retryable.

setStartToCloseTimeout

public StartActivityOptions.Builder setStartToCloseTimeout(Duration startToCloseTimeout)

Maximum time for a single attempt. Either this or setScheduleToCloseTimeout(Duration) is required.

setHeartbeatTimeout

public StartActivityOptions.Builder setHeartbeatTimeout(Duration heartbeatTimeout)

Maximum time between heartbeats before the server considers the activity failed.

setIdReusePolicy

public StartActivityOptions.Builder setIdReusePolicy(io.temporal.api.enums.v1.ActivityIdReusePolicy idReusePolicy)

Controls behavior when an activity with the same ID was previously run and is now closed. Defaults to ALLOW_DUPLICATE.

setIdConflictPolicy

public StartActivityOptions.Builder setIdConflictPolicy(io.temporal.api.enums.v1.ActivityIdConflictPolicy idConflictPolicy)

Controls behavior when an activity with the same ID is currently running. Defaults to UNSPECIFIED which maps to the server default (fail).

setRetryOptions

public StartActivityOptions.Builder setRetryOptions(RetryOptions retryOptions)

Retry policy. If not set the server default is used.

setTypedSearchAttributes

public StartActivityOptions.Builder setTypedSearchAttributes(SearchAttributes typedSearchAttributes)

Typed search attributes to attach to this activity execution.

setStaticSummary

public StartActivityOptions.Builder setStaticSummary(String staticSummary)

Short static summary for UI display; encoded as a payload in UserMetadata.

setStaticDetails

public StartActivityOptions.Builder setStaticDetails(String staticDetails)

Longer static details for UI display; encoded as a payload in UserMetadata.

setPriority

public StartActivityOptions.Builder setPriority(Priority priority)

Priority hint for task routing.

setStartDelay

public StartActivityOptions.Builder setStartDelay(Duration startDelay)

Time to wait before dispatching the first activity task. The delay is one-shot — retry attempts do not re-apply it. ScheduleToStart and ScheduleToClose timeouts begin counting only after the delay elapses. Must be non-negative; null or Duration.ZERO mean no delay.

build

public StartActivityOptions build()