Package com.mypurecloud.sdk.v2.model

Class FlowCharacteristics

java.lang.Object
com.mypurecloud.sdk.v2.model.FlowCharacteristics
All Implemented Interfaces:
Serializable
public class FlowCharacteristics extends Object implements Serializable
This is a set of enabled characteristics for the loglevel
See Also:

  • Constructor Details

    • FlowCharacteristics

      public FlowCharacteristics()

    • FlowCharacteristics

      public FlowCharacteristics(Boolean initWithEmptyList)

  • Method Details

    • executionItems

      public FlowCharacteristics executionItems(Boolean executionItems)
      Whether to report execution data about individual actions, menus, states, tasks, etc. etc. that ran during execution of the flow.

    • getExecutionItems

      public Boolean getExecutionItems()

    • setExecutionItems

      public void setExecutionItems(Boolean executionItems)

    • executionInputOutputs

      public FlowCharacteristics executionInputOutputs(Boolean executionInputOutputs)
      Whether to report input setting input setting values and output data values for individual execution items above. For example, if you have FlowExecutionInputOutputs and a Call Data Action ran in a flow, if FlowExecutionItems was enabled you'd see the fact a Call Data Action ran and the output path it took but nothing about which Data Action it ran, the input data sent to it at flow runtime and the data returned from it. If you enable this characteristic, execution data will contain this additional detail.

    • getExecutionInputOutputs

      public Boolean getExecutionInputOutputs()

    • setExecutionInputOutputs

      public void setExecutionInputOutputs(Boolean executionInputOutputs)

    • communications

      public FlowCharacteristics communications(Boolean communications)
      Communications are either audio or digital communications sent to or received from a participant. An example here would be the initial greeting in an inbound call flow where it plays a greeting message to the participant.

    • getCommunications

      public Boolean getCommunications()

    • setCommunications

      public void setCommunications(Boolean communications)

    • eventError

      public FlowCharacteristics eventError(Boolean eventError)
      Whether to report flow error events.

    • getEventError

      public Boolean getEventError()

    • setEventError

      public void setEventError(Boolean eventError)

    • eventWarning

      public FlowCharacteristics eventWarning(Boolean eventWarning)
      Whether to report flow warning events.

    • getEventWarning

      public Boolean getEventWarning()

    • setEventWarning

      public void setEventWarning(Boolean eventWarning)

    • eventOther

      public FlowCharacteristics eventOther(Boolean eventOther)
      Whether to report events other than errors or warnings such as a language change, loop event.

    • getEventOther

      public Boolean getEventOther()

    • setEventOther

      public void setEventOther(Boolean eventOther)

    • variables

      public FlowCharacteristics variables(Boolean variables)
      Whether to report assignment of values to variables in flow execution data. It's important to remember there is a difference between variable value assignments and output data from an action. If you have a Call Digital Bot flow action in an Inbound Message flow and there is no variable bound to the Exit Reason output but FlowExecutionInputOutputs is enabled, you will still be able to see the exit reason from the digital bot flow in execution data even though it is not bound to a variable.

    • getVariables

      public Boolean getVariables()

    • setVariables

      public void setVariables(Boolean variables)

    • names

      public FlowCharacteristics names(Boolean names)
      This characteristic specifies whether or not name information should be emitted in execution data such as action, task, state or even the flow name itself. Names are very handy from a readability standpoint but they do take up additional space in flow execution data instances.

    • getNames

      public Boolean getNames()

    • setNames

      public void setNames(Boolean names)

    • 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