Package com.mypurecloud.sdk.v2.model

Class FlowExecutionLaunchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.FlowExecutionLaunchRequest

All Implemented Interfaces:

Serializable

public class FlowExecutionLaunchRequest
extends Object
implements Serializable

Parameters for launching a flow.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FlowExecutionLaunchRequest()
FlowExecutionLaunchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
FlowExecutionLaunchRequest	flowId(String flowId)	ID of the flow to launch.
FlowExecutionLaunchRequest	flowVersion(String flowVersion)	The version of the flow to launch.
String	getFlowId()
String	getFlowVersion()
Map<String,Object>	getInputData()
String	getName()
int	hashCode()
FlowExecutionLaunchRequest	inputData(Map<String,Object> inputData)	Input values to the flow.
FlowExecutionLaunchRequest	name(String name)	A displayable name to assign to the new flow execution
void	setFlowId(String flowId)
void	setFlowVersion(String flowVersion)
void	setInputData(Map<String,Object> inputData)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FlowExecutionLaunchRequest

public FlowExecutionLaunchRequest()

FlowExecutionLaunchRequest

public FlowExecutionLaunchRequest(Boolean initWithEmptyList)

Method Details

flowId

public FlowExecutionLaunchRequest flowId(String flowId)

ID of the flow to launch.

getFlowId

public String getFlowId()

setFlowId

public void setFlowId(String flowId)

flowVersion

public FlowExecutionLaunchRequest flowVersion(String flowVersion)

The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version.

getFlowVersion

public String getFlowVersion()

setFlowVersion

public void setFlowVersion(String flowVersion)

inputData

public FlowExecutionLaunchRequest inputData(Map<String,Object> inputData)

Input values to the flow. Valid values are defined by a flow's input JSON schema.

getInputData

public Map<String,Object> getInputData()

setInputData

public void setInputData(Map<String,Object> inputData)

name

public FlowExecutionLaunchRequest name(String name)

A displayable name to assign to the new flow execution

getName

public String getName()

setName

public void setName(String name)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object