Class ScheduleActionStartWorkflow

java.lang.Object

io.temporal.client.schedules.ScheduleAction

io.temporal.client.schedules.ScheduleActionStartWorkflow

public final class ScheduleActionStartWorkflow
extends ScheduleAction

Schedule action to start a workflow.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduleActionStartWorkflow.Builder

Method Summary

Modifier and Type	Method	Description
EncodedValues	getArguments()	Arguments for the workflow.
Header	getHeader()	Get the headers that will be sent with each workflow scheduled.
WorkflowOptions	getOptions()	Get the workflow options used.
String	getWorkflowType()	Get the workflow type name.
static ScheduleActionStartWorkflow.Builder	newBuilder()
static ScheduleActionStartWorkflow.Builder	newBuilder(ScheduleActionStartWorkflow options)

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static ScheduleActionStartWorkflow.Builder newBuilder()

newBuilder

public static ScheduleActionStartWorkflow.Builder newBuilder(ScheduleActionStartWorkflow options)

getWorkflowType

public String getWorkflowType()

Get the workflow type name.

Returns:

the workflow type name.

getOptions

public WorkflowOptions getOptions()

Get the workflow options used. Note WorkflowOptions.getMemo() every value here is an instance of EncodedValues. To access, call EncodedValues.get(int, java.lang.Class<T>) with an index of 0.

Returns:

workflow options used for the scheduled workflows.

getHeader

public Header getHeader()

Get the headers that will be sent with each workflow scheduled.

Returns:

headers to be sent

getArguments

public EncodedValues getArguments()

Arguments for the workflow.

Returns:

the arguments used for the scheduled workflows.