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. All

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(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  8. def chain(newActionBuilders: Seq[ActionBuilder]): ScenarioBuilder
    Attributes
    protected
    Definition Classes
    ScenarioBuilder → Execs
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  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 = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  17. def doWhileDuring(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  18. def during(duration: Expression[Duration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  19. def during(duration: Duration, counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  22. def exec(execs: Iterable[Execs[_]]): ScenarioBuilder
    Definition Classes
    Execs
  23. def exec(execs: Execs[_]*): ScenarioBuilder
    Definition Classes
    Execs
  24. def exec(actionBuilder: ActionBuilder): ScenarioBuilder
    Definition Classes
    Execs
  25. def exec(sessionFunction: Expression[Session]): ScenarioBuilder
    Definition Classes
    Execs
  26. def exitBlockOnFail(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
  27. def exitHere: ScenarioBuilder
    Definition Classes
    Errors
  28. def exitHereIf(condition: Expression[Boolean]): ScenarioBuilder
    Definition Classes
    Errors
  29. def exitHereIfFailed: ScenarioBuilder
    Definition Classes
    Errors
  30. 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
  31. 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
  32. 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
  33. 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
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  36. def forever(counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = false)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  37. def forever(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
  38. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. def group(name: Expression[String])(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Groups
  40. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def inject[T](iss: Iterable[T])(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  42. def inject[T](is: T, moreIss: T*)(implicit arg0: InjectionProfileFactory[T]): PopulationBuilder
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. val name: String
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. def pace(duration: Expression[FiniteDuration], counter: String): ScenarioBuilder
    Definition Classes
    Pauses
  49. def pace(duration: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  50. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  51. def pace(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  52. def pace(min: FiniteDuration, max: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  53. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): ScenarioBuilder
    Definition Classes
    Pauses
    Annotations
    @SuppressWarnings()
  54. def pace(duration: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  55. def pause(duration: Expression[FiniteDuration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  56. def pause(duration: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  57. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration], force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  58. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): ScenarioBuilder
    Definition Classes
    Pauses
  59. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  60. def pause(min: String, max: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  61. def pause(min: FiniteDuration, max: FiniteDuration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  62. def pause(min: FiniteDuration, max: FiniteDuration): ScenarioBuilder
    Definition Classes
    Pauses
  63. def pause(duration: String, unit: TimeUnit, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  64. def pause(duration: String, unit: TimeUnit): ScenarioBuilder
    Definition Classes
    Pauses
  65. def pause(duration: String, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  66. def pause(duration: String): ScenarioBuilder
    Definition Classes
    Pauses
  67. def pause(duration: FiniteDuration, force: PauseType): ScenarioBuilder
    Definition Classes
    Pauses
  68. 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
  69. 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
  70. 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
  71. def rendezVous(users: Int): ScenarioBuilder
    Definition Classes
    Pauses
  72. def repeat(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  73. 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
  74. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  75. def toString(): String
    Definition Classes
    AnyRef → Any
  76. def tryMax(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): ScenarioBuilder
    Definition Classes
    Errors
    Annotations
    @SuppressWarnings()
  77. 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
  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @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