Packages

t

io.gatling.core.structure

StructureBuilder

trait StructureBuilder[B <: StructureBuilder[B]] extends Execs[B] with Pauses[B] with Feeds[B] with Loops[B] with ConditionalStatements[B] with Errors[B] with Groups[B]

This trait defines most of the scenario related DSL

Linear Supertypes
Groups[B], Errors[B], ConditionalStatements[B], Loops[B], Feeds[B], Pauses[B], Execs[B], AnyRef, Any
Known Subclasses
CoreDsl, Predef, ChainBuilder, ScenarioBuilder, StructureSupport
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StructureBuilder
  2. Groups
  3. Errors
  4. ConditionalStatements
  5. Loops
  6. Feeds
  7. Pauses
  8. Execs
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def actionBuilders: List[ActionBuilder]
    Attributes
    protected
    Definition Classes
    Execs
  2. abstract def chain(newActionBuilders: Seq[ActionBuilder]): B
    Attributes
    protected
    Definition Classes
    Execs

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asLongAs(condition: Expression[Boolean], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = false)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  6. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  7. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  8. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  9. def asLongAsDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration])(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  10. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  11. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  12. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int, counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  13. def asLongAsDuring[D](condition: Expression[Boolean], duration: Int)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  14. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  15. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  16. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  17. def asLongAsDuring[D](condition: String, duration: Expression[FiniteDuration])(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  18. def asLongAsDuring[D](condition: String, duration: Int, counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  19. def asLongAsDuring[D](condition: String, duration: Int, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  20. def asLongAsDuring[D](condition: String, duration: Int, counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  21. def asLongAsDuring[D](condition: String, duration: Int)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  23. def doIf(condition: Expression[Boolean])(thenChain: Executable, thenChains: Executable*): B

    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

    thenChain

    the first chain to be executed if the condition is satisfied

    thenChains

    the other chains to be executed if the condition is satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  24. def doIfEquals(actual: Expression[Any], expected: Expression[Any])(thenChain: Executable, thenChains: Executable*): B

    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

    thenChain

    the first chain to be executed if the condition is satisfied

    thenChains

    the other chains to be executed if the condition is satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  25. def doIfEqualsOrElse(actual: Expression[Any], expected: Expression[Any])(thenChain: Executable, thenChains: Executable*)(elseChain: Executable, elseChains: Executable*): B

    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

    thenChain

    the first chain to be executed if the actual and expected values are equal

    thenChains

    the other chains to be executed if the actual and expected values are equal

    elseChain

    the first chain to be executed if the actual and expected values are not equal

    elseChains

    the other chains to be executed if the actual and expected values are not equal

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  26. def doIfOrElse(condition: Expression[Boolean])(thenChain: Executable, thenChains: Executable*)(elseChain: Executable, elseChains: Executable*): B

    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

    thenChain

    the first chain to be executed if the condition is satisfied

    thenChains

    the other chains to be executed if the condition is satisfied

    elseChain

    the first chain to be executed if the condition is not satisfied

    elseChains

    the other chains to be executed if the condition is not satisfied

    returns

    a new builder with a conditional execution added to its actions

    Definition Classes
    ConditionalStatements
  27. def doSwitch(value: Expression[Any])(possibilities: (Any, Executable)*): B

    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
  28. def doSwitchOrElse(value: Expression[Any])(possibilities: (Any, Executable)*)(elseChain: Executable, elseChains: Executable*): B

    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

    elseChain

    the first chain to be executed if the actual and expected values are not equal

    elseChains

    the other chains to be executed if the actual and expected values are not equal

    returns

    a new builder with a switch added to its actions

    Definition Classes
    ConditionalStatements
  29. def doWhile(condition: Expression[Boolean], counterName: String = UUID.randomUUID.toString)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  30. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  31. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  32. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration], counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  33. def doWhileDuring[D](condition: Expression[Boolean], duration: Expression[FiniteDuration])(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  34. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  35. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  36. def doWhileDuring[D](condition: Expression[Boolean], duration: Int, counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  37. def doWhileDuring[D](condition: Expression[Boolean], duration: Int)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  38. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  39. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  40. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration], counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  41. def doWhileDuring[D](condition: String, duration: Expression[FiniteDuration])(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  42. def doWhileDuring[D](condition: String, duration: Int, counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  43. def doWhileDuring[D](condition: String, duration: Int, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  44. def doWhileDuring[D](condition: String, duration: Int, counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  45. def doWhileDuring[D](condition: String, duration: Int)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  46. def during(duration: Expression[FiniteDuration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  47. def during(duration: Int, counterName: String, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  48. def during(duration: Int, exitASAP: Boolean)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  49. def during(duration: Int, counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  50. def during(duration: Int)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  51. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  53. def exec(execs: Iterable[Executable]): B
    Definition Classes
    Execs
  54. def exec(head: Executable, tail: Executable*): B
    Definition Classes
    Execs
  55. def exec(sessionFunction: Expression[Session]): B
    Definition Classes
    Execs
  56. def exitBlockOnFail(chain: Executable, chains: Executable*): B
    Definition Classes
    Errors
  57. def exitHere: B
    Definition Classes
    Errors
  58. def exitHereIf(condition: Expression[Boolean]): B
    Definition Classes
    Errors
  59. def exitHereIfFailed: B
    Definition Classes
    Errors
  60. def feed(feeder: Feeder[Any], number: Expression[Int]): B

    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
  61. def feed(feeder: Feeder[Any], number: String): B

    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
  62. def feed(feeder: Feeder[Any]): B

    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
  63. def feed(feederBuilder: FeederBuilder, number: Expression[Int]): B

    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
  64. def feed(feederBuilder: FeederBuilder): B

    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
  65. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = UUID.randomUUID.toString)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  66. def forever(counterName: String)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  67. def forever(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
  68. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  69. def group(name: Expression[String])(chain: Executable, chains: Executable*): B
    Definition Classes
    Groups
  70. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  71. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  75. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration], counter: String): B
    Definition Classes
    Pauses
  76. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  77. def pace(min: String, max: String, unit: TimeUnit, counter: String): B
    Definition Classes
    Pauses
  78. def pace(min: String, max: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  79. def pace(min: FiniteDuration, max: FiniteDuration, counter: String): B
    Definition Classes
    Pauses
  80. def pace(min: FiniteDuration, max: FiniteDuration): B
    Definition Classes
    Pauses
  81. def pace(duration: Expression[FiniteDuration], counter: String): B
    Definition Classes
    Pauses
  82. def pace(duration: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  83. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): B
    Definition Classes
    Pauses
    Annotations
    @SuppressWarnings()
  84. def pace(duration: FiniteDuration, counter: String): B
    Definition Classes
    Pauses
  85. def pace(duration: FiniteDuration): B
    Definition Classes
    Pauses
  86. def pause(duration: Expression[FiniteDuration], force: PauseType): B
    Definition Classes
    Pauses
  87. def pause(duration: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  88. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration], force: PauseType): B
    Definition Classes
    Pauses
  89. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  90. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): B
    Definition Classes
    Pauses
  91. def pause(min: String, max: String, force: PauseType): B
    Definition Classes
    Pauses
  92. def pause(min: String, max: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  93. def pause(min: String, max: String): B
    Definition Classes
    Pauses
  94. def pause(min: FiniteDuration, max: FiniteDuration, force: PauseType): B
    Definition Classes
    Pauses
  95. def pause(min: FiniteDuration, max: FiniteDuration): B
    Definition Classes
    Pauses
  96. def pause(duration: String, unit: TimeUnit, force: PauseType): B
    Definition Classes
    Pauses
  97. def pause(duration: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  98. def pause(duration: String, force: PauseType): B
    Definition Classes
    Pauses
  99. def pause(duration: String): B
    Definition Classes
    Pauses
  100. def pause(duration: FiniteDuration, force: PauseType): B
    Definition Classes
    Pauses
  101. def pause(duration: FiniteDuration): B

    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
  102. def randomSwitch(possibilities: (Double, Executable)*): B

    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
  103. def randomSwitchOrElse(possibilities: (Double, Executable)*)(elseChain: Executable, otherChains: Executable*): B

    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

    elseChain

    first fallback subchain

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  104. def rendezVous(users: Int): B
    Definition Classes
    Pauses
  105. def repeat(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: Executable, chains: Executable*): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  106. def roundRobinSwitch(possibilities: Executable*): B

    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
  107. def stopInjector(message: Expression[String]): B
    Definition Classes
    Errors
  108. def stopInjectorIf(message: Expression[String], condition: Expression[Boolean]): B
    Definition Classes
    Errors
  109. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  110. def toString(): String
    Definition Classes
    AnyRef → Any
  111. def tryMax(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: Executable, chains: Executable*): B
    Definition Classes
    Errors
    Annotations
    @SuppressWarnings()
  112. def uniformRandomSwitch(possibilities: Executable*): B

    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
  113. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  114. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  115. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Groups[B]

Inherited from Errors[B]

Inherited from ConditionalStatements[B]

Inherited from Loops[B]

Inherited from Feeds[B]

Inherited from Pauses[B]

Inherited from Execs[B]

Inherited from AnyRef

Inherited from Any

Ungrouped