Package com.microsoft.durabletask

Class NewOrchestrationInstanceOptions

java.lang.Object

com.microsoft.durabletask.NewOrchestrationInstanceOptions

public final class NewOrchestrationInstanceOptions
extends java.lang.Object

Options for starting a new instance of an orchestration.

Constructor Summary

Constructors

Constructor	Description
NewOrchestrationInstanceOptions()	Default constructor for the NewOrchestrationInstanceOptions class.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getInput()	Gets the input of the new orchestration.
java.lang.String	getInstanceId()	Gets the instance ID of the new orchestration.
java.time.Instant	getStartTime()	Gets the configured start time of the new orchestration instance.
java.lang.String	getVersion()	Gets the user-specified version of the new orchestration.
NewOrchestrationInstanceOptions	setInput(java.lang.Object input)	Sets the input of the orchestration to start.
NewOrchestrationInstanceOptions	setInstanceId(java.lang.String instanceId)	Sets the instance ID of the orchestration to start.
NewOrchestrationInstanceOptions	setStartTime(java.time.Instant startTime)	Sets the start time of the new orchestration instance.
NewOrchestrationInstanceOptions	setVersion(java.lang.String version)	Sets the version of the orchestration to start.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewOrchestrationInstanceOptions

public NewOrchestrationInstanceOptions()

Default constructor for the NewOrchestrationInstanceOptions class.

Method Detail

setVersion

public NewOrchestrationInstanceOptions setVersion(java.lang.String version)

Sets the version of the orchestration to start.

Parameters:

version - the user-defined version of the orchestration

Returns:

this NewOrchestrationInstanceOptions object

setInstanceId

public NewOrchestrationInstanceOptions setInstanceId(java.lang.String instanceId)

Sets the instance ID of the orchestration to start.

If no instance ID is configured, the orchestration will be created with a randomly generated instance ID.

Parameters:

instanceId - the ID of the new orchestration instance

Returns:

this NewOrchestrationInstanceOptions object

setInput

public NewOrchestrationInstanceOptions setInput(java.lang.Object input)

Sets the input of the orchestration to start.

There are no restrictions on the type of inputs that can be used except that they must be serializable using the DataConverter that was configured for the DurableTaskClient at creation time.

Parameters:

input - the input of the new orchestration instance

Returns:

this NewOrchestrationInstanceOptions object

setStartTime

public NewOrchestrationInstanceOptions setStartTime(java.time.Instant startTime)

Sets the start time of the new orchestration instance.

By default, new orchestration instances start executing immediately. This method can be used to start them at a specific time in the future.

Parameters:

startTime - the start time of the new orchestration instance

Returns:

this NewOrchestrationInstanceOptions object

getVersion

public java.lang.String getVersion()

Gets the user-specified version of the new orchestration.

Returns:

the user-specified version of the new orchestration.

getInstanceId

public java.lang.String getInstanceId()

Gets the instance ID of the new orchestration.

Returns:

the instance ID of the new orchestration.

getInput

public java.lang.Object getInput()

Gets the input of the new orchestration.

Returns:

the input of the new orchestration.

getStartTime

public java.time.Instant getStartTime()

Gets the configured start time of the new orchestration instance.

Returns:

the configured start time of the new orchestration instance.