Packages

c

io.gatling.core.structure

ScenarioBuilder

case class ScenarioBuilder(name: String, actionBuilders: List[ActionBuilder] = Nil) extends StructureBuilder[ScenarioBuilder] with BuildAction with Product with Serializable

The scenario builder is used in the DSL to define the scenario

name

the name of the scenario

actionBuilders

the list of all the actions that compose the scenario

Linear Supertypes
Serializable, Serializable, Product, Equals, BuildAction, StructureBuilder[ScenarioBuilder], Groups[ScenarioBuilder], Errors[ScenarioBuilder], ConditionalStatements[ScenarioBuilder], Loops[ScenarioBuilder], Feeds[ScenarioBuilder], Pauses[ScenarioBuilder], Execs[ScenarioBuilder], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScenarioBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. BuildAction
  7. StructureBuilder
  8. Groups
  9. Errors
  10. ConditionalStatements
  11. Loops
  12. Feeds
  13. Pauses
  14. Execs
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScenarioBuilder(name: String, actionBuilders: List[ActionBuilder] = Nil)

    name

    the name of the scenario

    actionBuilders

    the list of all the actions that compose the scenario

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val actionBuilders: List[ActionBuilder]
    Definition Classes
    ScenarioBuilder → Execs
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asLongAs(condition: Expression[Boolean], counterName: String = FastUUID.toString(UUID.randomUUID), exitASAP: Boolean = false)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  7. def asLongAsDuring(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = FastUUID.toString(UUID.randomUUID), exitASAP: Boolean = true)(chain: ChainBuilder)(implicit clock: Clock): ScenarioBuilder
    Definition Classes
    Loops
  8. def chain(newActionBuilders: Seq[ActionBuilder]): ScenarioBuilder
    Attributes
    protected
    Definition Classes
    ScenarioBuilder → Execs
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def doIf(condition: Expression[Boolean])(thenNext: ChainBuilder): ScenarioBuilder

    Method used to add a conditional execution in the scenario

    Method used to add a conditional execution in the scenario

    condition

    the function that will determine if the condition is satisfied or not

    thenNext

    the chain to be executed if the condition is satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  11. def doIfEquals(actual: Expression[Any], expected: Expression[Any])(thenNext: ChainBuilder): ScenarioBuilder

    Method used to add a conditional execution in the scenario

    Method used to add a conditional execution in the scenario

    actual

    the real value

    expected

    the expected value

    thenNext

    the chain to be executed if the condition is satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  12. def doIfEqualsOrElse(actual: Expression[Any], expected: Expression[Any])(thenNext: ChainBuilder)(elseNext: ChainBuilder): ScenarioBuilder

    Method used to add a conditional execution in the scenario with a fall back action if condition is not satisfied

    Method used to add a conditional execution in the scenario with a fall back action if condition is not satisfied

    actual

    the real value

    expected

    the expected value

    thenNext

    the chain to be executed if the condition is satisfied

    elseNext

    the chain to be executed if the condition is not satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  13. def doIfOrElse(condition: Expression[Boolean])(thenNext: ChainBuilder)(elseNext: ChainBuilder): ScenarioBuilder

    Method used to add a conditional execution in the scenario with a fall back action if condition is not satisfied

    Method used to add a conditional execution in the scenario with a fall back action if condition is not satisfied

    condition

    the function that will determine if the condition is satisfied or not

    thenNext

    the chain to be executed if the condition is satisfied

    elseNext

    the chain to be executed if the condition is not satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  14. def doSwitch(value: Expression[Any])(possibilities: (Any, ChainBuilder)*): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Every possible subchain is defined with a key. Switch is selected through the matching of a key with the evaluation of the passed expression. If no switch is selected, switch is bypassed.

    value

    expression to evaluate and match to find the right subchain

    possibilities

    tuples of key and subchain

    returns

    a new builder with a switch added to its actions

    Definition Classes
    ConditionalStatements
  15. def doSwitchOrElse(value: Expression[Any])(possibilities: (Any, ChainBuilder)*)(elseNext: ChainBuilder): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Every possible subchain is defined with a key. Switch is selected through the matching of a key with the evaluation of the passed expression. If no switch is selected, the fallback subchain is used.

    value

    expression to evaluate and match to find the right subchain

    possibilities

    tuples of key and subchain

    elseNext

    fallback subchain

    returns

    a new builder with a switch added to its actions

    Definition Classes
    ConditionalStatements
  16. def doWhile(condition: Expression[Boolean], counterName: String = FastUUID.toString(UUID.randomUUID))(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  17. def doWhileDuring(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = FastUUID.toString(UUID.randomUUID), exitASAP: Boolean = true)(chain: ChainBuilder)(implicit clock: Clock): ScenarioBuilder
    Definition Classes
    Loops
  18. def during(duration: Expression[Duration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder)(implicit clock: Clock): ScenarioBuilder
    Definition Classes
    Loops
  19. def during(duration: Duration, counterName: String = FastUUID.toString(UUID.randomUUID), exitASAP: Boolean = true)(chain: ChainBuilder)(implicit clock: Clock): ScenarioBuilder
    Definition Classes
    Loops
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def exec(execs: Iterable[Execs[_]]): ScenarioBuilder
    Definition Classes
    Execs
  22. def exec(execs: Execs[_]*): ScenarioBuilder
    Definition Classes
    Execs
  23. def exec(actionBuilder: ActionBuilder): ScenarioBuilder
    Definition Classes
    Execs
  24. def exec(sessionFunction: Expression[Session]): ScenarioBuilder
    Definition Classes
    Execs
  25. def exitBlockOnFail(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
  26. def exitHereIfFailed: ScenarioBuilder
    Definition Classes
    Errors
  27. def feed(feederBuilder: FeederBuilder, number: Expression[Int] = Feeds.OneExpression): ScenarioBuilder

    Method used to load data from a feeder in the current scenario

    Method used to load data from a feeder in the current scenario

    feederBuilder

    the feeder from which the values will be loaded

    number

    the number of records to be polled (default 1)

    Definition Classes
    Feeds
  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = FastUUID.toString(UUID.randomUUID))(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  30. def forever(counterName: String = FastUUID.toString(UUID.randomUUID), exitASAP: Boolean = false)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  31. def forever(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def group(name: Expression[String])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Groups
  34. def inject(meta: MetaInjectionProfile): PopulationBuilder
  35. def inject[T](iss: Iterable[T])(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  36. def inject[T](is: T, moreIss: T*)(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. val name: String
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. def pace(duration: Expression[Duration], counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  43. def pace(duration: Expression[Duration]): ScenarioBuilder
    Definition Classes
    Pauses
  44. def pace(min: Expression[Duration], max: Expression[Duration]): ScenarioBuilder
    Definition Classes
    Pauses
  45. def pace(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  46. def pace(min: Duration, max: Duration): ScenarioBuilder
    Definition Classes
    Pauses
  47. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): ScenarioBuilder
    Definition Classes
    Pauses
  48. def pace(duration: Duration): ScenarioBuilder
    Definition Classes
    Pauses
  49. def pause(duration: Expression[Duration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  50. def pause(duration: Expression[Duration]): ScenarioBuilder
    Definition Classes
    Pauses
  51. def pause(min: Expression[Duration], max: Expression[Duration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  52. def pause(min: Expression[Duration], max: Expression[Duration]): ScenarioBuilder
    Definition Classes
    Pauses
  53. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  54. def pause(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  55. def pause(min: Duration, max: Duration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  56. def pause(min: Duration, max: Duration): ScenarioBuilder
    Definition Classes
    Pauses
  57. def pause(duration: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  58. def pause(duration: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  59. def pause(duration: String, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  60. def pause(duration: String): ScenarioBuilder
    Definition Classes
    Pauses
  61. def pause(duration: Duration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  62. def pause(duration: Duration): ScenarioBuilder

    Method used to define a pause based on a duration defined in the session

    Method used to define a pause based on a duration defined in the session

    duration

    Expression that when resolved, provides the pause duration

    returns

    a new builder with a pause added to its actions

    Definition Classes
    Pauses
  63. def randomSwitch(possibilities: (Double, ChainBuilder)*): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Every possible subchain is defined with a percentage. Switch is selected randomly. If no switch is selected (ie: random number exceeds percentages sum), switch is bypassed. Percentages sum can't exceed 100%.

    possibilities

    the possible subchains

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  64. def randomSwitchOrElse(possibilities: (Double, ChainBuilder)*)(elseNext: ChainBuilder): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Every possible subchain is defined with a percentage. Switch is selected randomly. If no switch is selected (ie: random number exceeds percentages sum), the subchain defined as the fallback will be used. Percentages sum must be below 100%.

    possibilities

    the possible subchains

    elseNext

    fallback subchain

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  65. def rendezVous(users: Int): ScenarioBuilder
    Definition Classes
    Pauses
  66. def repeat(times: Expression[Int], counterName: String = FastUUID.toString(UUID.randomUUID))(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  67. def roundRobinSwitch(possibilities: ChainBuilder*): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Selection uses a round robin strategy

    possibilities

    the possible subchains

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  68. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  69. def tryMax(times: Expression[Int], counter: String = FastUUID.toString(UUID.randomUUID))(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
  70. def uniformRandomSwitch(possibilities: ChainBuilder*): ScenarioBuilder

    Add a switch in the chain.

    Add a switch in the chain. Selection uses a uniformly distributed random strategy

    possibilities

    the possible subchains

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BuildAction

Inherited from StructureBuilder[ScenarioBuilder]

Inherited from Groups[ScenarioBuilder]

Inherited from Errors[ScenarioBuilder]

Inherited from ConditionalStatements[ScenarioBuilder]

Inherited from Loops[ScenarioBuilder]

Inherited from Feeds[ScenarioBuilder]

Inherited from Pauses[ScenarioBuilder]

Inherited from Execs[ScenarioBuilder]

Inherited from AnyRef

Inherited from Any

Ungrouped