Share via

NewOrchestrationInstanceOptions Class

Package:
com.microsoft.durabletask
Maven Artifact:
com.microsoft:durabletask-client:1.0.0
  • java.lang.Object
    • com.microsoft.durabletask.NewOrchestrationInstanceOptions

public final class NewOrchestrationInstanceOptions

Options for starting a new instance of an orchestration.

Constructor Summary

Constructor Description
NewOrchestrationInstanceOptions()

Default constructor for the NewOrchestrationInstanceOptions class.

Method Summary

Modifier and Type Method and 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(Object input)

Sets the input of the orchestration to start.
NewOrchestrationInstanceOptions setInstanceId(String instanceId)

Sets the instance ID of the orchestration to start.
NewOrchestrationInstanceOptions setStartTime(Instant startTime)

Sets the start time of the new orchestration instance.
NewOrchestrationInstanceOptions setVersion(String version)

Sets the version of the orchestration to start.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

NewOrchestrationInstanceOptions

public NewOrchestrationInstanceOptions()

Default constructor for the NewOrchestrationInstanceOptions class.

Method Details

getInput

public Object getInput()

Gets the input of the new orchestration.

Returns:

the input of the new orchestration.

getInstanceId

public String getInstanceId()

Gets the instance ID of the new orchestration.

Returns:

the instance ID of the new orchestration.

getStartTime

public Instant getStartTime()

Gets the configured start time of the new orchestration instance.

Returns:

the configured start time of the new orchestration instance.

getVersion

public String getVersion()

Gets the user-specified version of the new orchestration.

Returns:

the user-specified version of the new orchestration.

setInput

public NewOrchestrationInstanceOptions setInput(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:

setInstanceId

public NewOrchestrationInstanceOptions setInstanceId(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:

setStartTime

public NewOrchestrationInstanceOptions setStartTime(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:

setVersion

public NewOrchestrationInstanceOptions setVersion(String version)

Sets the version of the orchestration to start.

Parameters:

version - the user-defined version of the orchestration

Returns:

Applies to