Packages

c

io.gatling.core.structure

ScenarioBuilder

final class ScenarioBuilder extends StructureBuilder[ScenarioBuilder] with BuildAction

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

Linear Supertypes
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. BuildAction
  3. StructureBuilder
  4. Groups
  5. Errors
  6. ConditionalStatements
  7. Loops
  8. Feeds
  9. Pauses
  10. Execs
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

    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 = UUID.randomUUID.toString, exitASAP: Boolean = false)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  7. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  8. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  9. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  10. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  11. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  12. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  13. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  14. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  15. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  16. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  17. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  18. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  19. def asLongAsDuring[D](condition: String, duration: Int, counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  20. def asLongAsDuring[D](condition: String, duration: Int, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  21. def asLongAsDuring[D](condition: String, duration: Int, counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  22. def asLongAsDuring[D](condition: String, duration: Int)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  23. def chain(newActionBuilders: Seq[ActionBuilder]): ScenarioBuilder
    Attributes
    protected
    Definition Classes
    ScenarioBuilder → Execs
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  25. 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
  26. 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
  27. 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
  28. 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
  29. 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
  30. 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
  31. def doWhile(condition: Expression[Boolean], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  32. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  33. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  34. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  35. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  36. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  37. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  38. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  39. def doWhileDuring[D](condition: Expression[Boolean], duration: Int)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  40. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  41. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  42. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  43. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  44. def doWhileDuring[D](condition: String, duration: Int, counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  45. def doWhileDuring[D](condition: String, duration: Int, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  46. def doWhileDuring[D](condition: String, duration: Int, counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  47. def doWhileDuring[D](condition: String, duration: Int)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  48. def during(duration: Expression[FiniteDuration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  49. def during(duration: Int, counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  50. def during(duration: Int, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  51. def during(duration: Int, counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  52. def during(duration: Int)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  53. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  55. def exec[T <: Execs[_]](execs: Iterable[T]): ScenarioBuilder
    Definition Classes
    Execs
  56. def exec[T <: Execs[_]](execs: T*): ScenarioBuilder
    Definition Classes
    Execs
  57. def exec(actionBuilder: ActionBuilder): ScenarioBuilder
    Definition Classes
    Execs
  58. def exec(sessionFunction: Expression[Session]): ScenarioBuilder
    Definition Classes
    Execs
  59. def exitBlockOnFail(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
  60. def exitHere: ScenarioBuilder
    Definition Classes
    Errors
  61. def exitHereIf(condition: Expression[Boolean]): ScenarioBuilder
    Definition Classes
    Errors
  62. def exitHereIfFailed: ScenarioBuilder
    Definition Classes
    Errors
  63. def feed(feeder: Feeder[Any], number: Expression[Int]): ScenarioBuilder

    Chain an action that will inject multiple data records into the virtual users' Session

    Chain an action that will inject multiple data records into the virtual users' Session

    feeder

    a source of records

    number

    the number of records to be injected

    Definition Classes
    Feeds
  64. def feed(feeder: Feeder[Any], number: String): ScenarioBuilder

    Chain an action that will inject multiple data records into the virtual users' Session

    Chain an action that will inject multiple data records into the virtual users' Session

    feeder

    a source of records

    number

    the number of records to be injected

    Definition Classes
    Feeds
  65. def feed(feeder: Feeder[Any]): ScenarioBuilder

    Chain an action that will inject a single data record into the virtual users' Session

    Chain an action that will inject a single data record into the virtual users' Session

    feeder

    a source of records

    Definition Classes
    Feeds
  66. def feed(feederBuilder: FeederBuilder, number: Expression[Int]): ScenarioBuilder

    Chain an action that will inject multiple data records into the virtual users' Session

    Chain an action that will inject multiple data records into the virtual users' Session

    feederBuilder

    a factory of a source of records

    number

    the number of records to be injected

    Definition Classes
    Feeds
  67. def feed(feederBuilder: FeederBuilder): ScenarioBuilder

    Chain an action that will inject a single data record into the virtual users' Session

    Chain an action that will inject a single data record into the virtual users' Session

    feederBuilder

    a factory of a source of records

    Definition Classes
    Feeds
  68. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  69. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  70. def forever(counterName: String)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  71. def forever(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  72. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  73. def group(name: Expression[String])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Groups
  74. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  75. def inject[T](iss: Iterable[T])(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  76. def inject[T](is: T, moreIss: T*)(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  77. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  78. val name: String
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration], counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  83. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  84. def pace(min: String, max: String, unit: TimeUnit, counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  85. def pace(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  86. def pace(min: FiniteDuration, max: FiniteDuration, counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  87. def pace(min: FiniteDuration, max: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  88. def pace(duration: Expression[FiniteDuration], counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  89. def pace(duration: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  90. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): ScenarioBuilder
    Definition Classes
    Pauses
    Annotations
    @SuppressWarnings()
  91. def pace(duration: FiniteDuration, counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  92. def pace(duration: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  93. def pause(duration: Expression[FiniteDuration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  94. def pause(duration: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  95. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  96. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  97. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  98. def pause(min: String, max: String, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  99. def pause(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  100. def pause(min: String, max: String): ScenarioBuilder
    Definition Classes
    Pauses
  101. def pause(min: FiniteDuration, max: FiniteDuration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  102. def pause(min: FiniteDuration, max: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  103. def pause(duration: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  104. def pause(duration: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  105. def pause(duration: String, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  106. def pause(duration: String): ScenarioBuilder
    Definition Classes
    Pauses
  107. def pause(duration: FiniteDuration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  108. def pause(duration: FiniteDuration): 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
  109. 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
  110. 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
  111. def rendezVous(users: Int): ScenarioBuilder
    Definition Classes
    Pauses
  112. def repeat(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  113. 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
  114. def stopInjector(message: Expression[String]): ScenarioBuilder
    Definition Classes
    Errors
  115. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  116. def toString(): String
    Definition Classes
    AnyRef → Any
  117. def tryMax(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
    Annotations
    @SuppressWarnings()
  118. 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
  119. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  120. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  121. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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