Class

io.gatling.core.structure

ScenarioBuilder

Related Doc: package structure

Permalink

case class ScenarioBuilder(name: String, actionBuilders: List[ActionBuilder] = Nil) extends StructureBuilder[ScenarioBuilder] 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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScenarioBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. StructureBuilder
  7. Groups
  8. Errors
  9. ConditionalStatements
  10. Loops
  11. Feeds
  12. Pauses
  13. Execs
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val actionBuilders: List[ActionBuilder]

    Permalink

    the list of all the actions that compose the scenario

    the list of all the actions that compose the scenario

    Definition Classes
    ScenarioBuilderExecs
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def asLongAs(condition: Expression[Boolean], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = false, loopType: LoopType = AsLongAsLoopType)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def doIf(condition: Expression[Boolean])(thenNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  9. def doIfEquals(actual: Expression[Any], expected: Expression[Any])(thenNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  10. def doIfEqualsOrElse(actual: Expression[Any], expected: Expression[Any])(thenNext: ChainBuilder)(elseNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  11. def doIfOrElse(condition: Expression[Boolean])(thenNext: ChainBuilder)(elseNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  12. def doSwitch(value: Expression[Any])(possibilities: (Any, ChainBuilder)*): ScenarioBuilder

    Permalink

    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
  13. def doSwitchOrElse(value: Expression[Any])(possibilities: (Any, ChainBuilder)*)(elseNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  14. def during(duration: Expression[Duration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  15. def during(duration: Duration, counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def exec(scenario: ScenarioBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  18. def exec(chains: Iterable[ChainBuilder]): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  19. def exec(chains: Iterator[ChainBuilder]): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  20. def exec(chains: ChainBuilder*): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  21. def exec(actionBuilder: ActionBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  22. def exec(sessionFunction: Expression[Session]): ScenarioBuilder

    Permalink
    Definition Classes
    Execs
  23. def exitBlockOnFail(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Errors
  24. def exitHereIfFailed: ScenarioBuilder

    Permalink
    Definition Classes
    Errors
  25. def feed(feederBuilder: FeederBuilder[_], number: Expression[Int] = Feeds.oneExpression): ScenarioBuilder

    Permalink

    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
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  28. def forever(counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = false)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  29. def forever(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  31. def group(name: Expression[String])(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Groups
  32. def inject(iss: Iterable[InjectionStep]): PopulationBuilder

    Permalink
  33. def inject(iss: InjectionStep*): PopulationBuilder

    Permalink
  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. val name: String

    Permalink

    the name of the scenario

  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. def pace(duration: Expression[Duration], counter: String): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  40. def pace(duration: Expression[Duration]): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  41. def pace(min: Expression[Duration], max: Expression[Duration]): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  42. def pace(min: String, max: String, unit: TimeUnit): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  43. def pace(min: Duration, max: Duration): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  44. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  45. def pace(duration: Duration): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  46. def pause(duration: Expression[Duration], force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  47. def pause(duration: Expression[Duration]): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  48. def pause(min: Expression[Duration], max: Expression[Duration], force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  49. def pause(min: Expression[Duration], max: Expression[Duration]): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  50. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  51. def pause(min: String, max: String, unit: TimeUnit): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  52. def pause(min: Duration, max: Duration, force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  53. def pause(min: Duration, max: Duration): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  54. def pause(duration: String, unit: TimeUnit, force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  55. def pause(duration: String, unit: TimeUnit): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  56. def pause(duration: String, force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  57. def pause(duration: String): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  58. def pause(duration: Duration, force: PauseType): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  59. def pause(duration: Duration): ScenarioBuilder

    Permalink

    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
  60. def randomSwitch(possibilities: (Double, ChainBuilder)*): ScenarioBuilder

    Permalink

    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
  61. def randomSwitchOrElse(possibilities: (Double, ChainBuilder)*)(elseNext: ChainBuilder): ScenarioBuilder

    Permalink

    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
  62. def rendezVous(users: Int): ScenarioBuilder

    Permalink
    Definition Classes
    Pauses
  63. def repeat(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Loops
  64. def roundRobinSwitch(possibilities: ChainBuilder*): ScenarioBuilder

    Permalink

    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
  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  66. def tryMax(times: Expression[Int], counter: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder

    Permalink
    Definition Classes
    Errors
  67. def uniformRandomSwitch(possibilities: ChainBuilder*): ScenarioBuilder

    Permalink

    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
  68. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Groups[ScenarioBuilder]

Inherited from Errors[ScenarioBuilder]

Inherited from Loops[ScenarioBuilder]

Inherited from Feeds[ScenarioBuilder]

Inherited from Pauses[ScenarioBuilder]

Inherited from Execs[ScenarioBuilder]

Inherited from AnyRef

Inherited from Any

Ungrouped