final case class ZChildWorkflowOptions extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZChildWorkflowOptions
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cancellationType: Option[ChildWorkflowCancellationType]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. val contextPropagators: List[ContextPropagator]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val memo: Map[String, AnyRef]
  12. val namespace: Option[String]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. val parentClosePolicy: Option[ParentClosePolicy]
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val retryOptions: Option[ZRetryOptions]
  19. val searchAttributes: Option[ZSearchAttributes]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val taskQueue: Option[String]
  22. def toJava: ChildWorkflowOptions

    Convert to Java SDK's ChildWorkflowOptions

  23. def toString(): String
    Definition Classes
    ZChildWorkflowOptions → AnyRef → Any
  24. def transformJavaOptions(f: (Builder) => Builder): ZChildWorkflowOptions

    Allows to specify options directly on the java SDK's ChildWorkflowOptions.

    Allows to specify options directly on the java SDK's ChildWorkflowOptions. Use it in case an appropriate withXXX method is missing

    Note

    the options specified via this method take precedence over those specified via other methods.

  25. val versioningIntent: Option[VersioningIntent]
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def withCancellationType(value: ChildWorkflowCancellationType): ZChildWorkflowOptions

    In case of a child workflow cancellation it fails with a zio.temporal.failure.CanceledFailure.

    In case of a child workflow cancellation it fails with a zio.temporal.failure.CanceledFailure. The type defines at which point the exception is thrown.

  30. def withContextPropagators(values: List[ContextPropagator]): ZChildWorkflowOptions

    Specifies the list of context propagators to use during this workflow.

  31. def withContextPropagators(values: ContextPropagator*): ZChildWorkflowOptions

    Specifies the list of context propagators to use during this workflow.

  32. def withMemo(values: Map[String, AnyRef]): ZChildWorkflowOptions

    Specifies additional non-indexed information in result of list workflow.

    Specifies additional non-indexed information in result of list workflow. The type of value can be any object that are serializable by io.temporal.common.converter.DataConverter

  33. def withMemo(values: (String, AnyRef)*): ZChildWorkflowOptions

    Specifies additional non-indexed information in result of list workflow.

    Specifies additional non-indexed information in result of list workflow. The type of value can be any object that are serializable by io.temporal.common.converter.DataConverter

  34. def withParentClosePolicy(value: ParentClosePolicy): ZChildWorkflowOptions

    Specifies how this workflow reacts to the death of the parent workflow.

  35. def withRetryOptions(value: ZRetryOptions): ZChildWorkflowOptions

    RetryOptions that define how child workflow is retried in case of failure.

    RetryOptions that define how child workflow is retried in case of failure. Default is null which is no reties.

  36. def withSearchAttributes(values: ZSearchAttributes): ZChildWorkflowOptions

    Specifies Search Attributes that will be attached to the Workflow.

    Specifies Search Attributes that will be attached to the Workflow. Search Attributes are additional indexed information attributed to workflow and used for search and visibility.

    The search attributes can be used in query of List/Scan/Count workflow APIs. The key and its value type must be registered on Temporal server side.

  37. def withSearchAttributes(values: Map[String, ZSearchAttribute]): ZChildWorkflowOptions

    Specifies Search Attributes that will be attached to the Workflow.

    Specifies Search Attributes that will be attached to the Workflow. Search Attributes are additional indexed information attributed to workflow and used for search and visibility.

    The search attributes can be used in query of List/Scan/Count workflow APIs. The key and its value type must be registered on Temporal server side.

  38. def withTaskQueue(value: String): ZChildWorkflowOptions

    Task queue to use for workflow tasks.

    Task queue to use for workflow tasks. It should match a task queue specified when creating a zio.temporal.worker.ZWorker that hosts the workflow code.

  39. def withVersioningIntent(value: VersioningIntent): ZChildWorkflowOptions

    Specifies whether this child workflow should run on a worker with a compatible Build Id or not.

    Specifies whether this child workflow should run on a worker with a compatible Build Id or not. See the variants of VersioningIntent.

  40. def withWorkflowExecutionTimeout(value: zio.Duration): ZChildWorkflowOptions

    The time after which child workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.

    The time after which child workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.
    Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

    When a workflow reaches Workflow Execution Timeout, it can't make any progress after that. Do not rely on this timeout in workflow implementation or business logic. This timeout is not designed to be handled in workflow code to perform any logic in case of timeout. Consider using workflow timers instead.

    If you catch yourself setting this timeout to very small values, you're likely using it wrong.

    Example: If Workflow Execution Timeout is 30 seconds and the network was unavailable for 1 minute, workflows that were scheduled before the network blip will never have a chance to make progress or react, and will be terminated.
    A timer that is scheduled in the workflow code using ZWorkflow.newTimer will handle this situation gracefully. A workflow with such a timer will start after the network blip. If it started before the network blip and the timer fires during the network blip, it will get delivered after connectivity is restored and the workflow will be able to resume.

  41. def withWorkflowId(value: String): ZChildWorkflowOptions

    Workflow id to use when starting.

    Workflow id to use when starting. Prefer assigning business meaningful ids if possible.

  42. def withWorkflowIdReusePolicy(value: WorkflowIdReusePolicy): ZChildWorkflowOptions

    Specifies server behavior if a completed workflow with the same id exists.

    Specifies server behavior if a completed workflow with the same id exists. Note that under no conditions Temporal allows two workflows with the same namespace and workflow id run simultaneously. -

    AllowDuplicateFailedOnly is a default value. It means that workflow can start if previous run failed or was canceled or terminated.

    AllowDuplicate allows new run independently of the previous run closure status.

    RejectDuplicate doesn't allow new run independently of the previous run closure status.

  43. def withWorkflowRunTimeout(value: zio.Duration): ZChildWorkflowOptions

    The time after which child workflow run is automatically terminated by Temporal service with CHILD_WORKFLOW_EXECUTION_TIMED_OUT status.

    The time after which child workflow run is automatically terminated by Temporal service with CHILD_WORKFLOW_EXECUTION_TIMED_OUT status.
    Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

    When a workflow reaches Workflow Run Timeout, it can't make any progress after that. Do not rely on this timeout in workflow implementation or business logic. This timeout is not designed to be handled in workflow code to perform any logic in case of timeout. Consider using workflow timers instead.

    If you catch yourself setting this timeout to very small values, you're likely using it wrong.

    Example: If Workflow Run Timeout is 30 seconds and the network was unavailable for 1 minute, workflows that were scheduled before the network blip will never have a chance to make progress or react, and will be terminated.
    A timer that is scheduled in the workflow code using ZWorkflow.newTimer will handle this situation gracefully. A workflow with such a timer will start after the network blip. If it started before the network blip and the timer fires during the network blip, it will get delivered after connectivity is restored and the workflow will be able to resume.

  44. def withWorkflowTaskTimeout(value: zio.Duration): ZChildWorkflowOptions

    Maximum execution time of a single workflow task.

    Maximum execution time of a single workflow task. Default is 10 seconds. Maximum accepted value is 60 seconds.

  45. val workflowExecutionTimeout: Option[zio.Duration]
  46. val workflowId: String
  47. val workflowIdReusePolicy: Option[WorkflowIdReusePolicy]
  48. val workflowRunTimeout: Option[zio.Duration]
  49. val workflowTaskTimeout: Option[zio.Duration]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped