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

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: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  6. def asLongAsDuring(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def doIf(condition: Expression[Boolean])(thenNext: ChainBuilder): 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

    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): 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

    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): 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

    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): 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

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

    elseNext

    fallback subchain

    returns

    a new builder with a switch added to its actions

    Definition Classes
    ConditionalStatements
  14. def doWhile(condition: Expression[Boolean], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  15. def doWhileDuring(condition: Expression[Boolean], duration: Expression[Duration], counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  16. def during(duration: Expression[Duration], counterName: String, exitASAP: Boolean)(chain: ChainBuilder): B
    Definition Classes
    Loops
  17. def during(duration: Duration, counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = true)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def exec(execs: Iterable[Execs[_]]): B
    Definition Classes
    Execs
  21. def exec(execs: Execs[_]*): B
    Definition Classes
    Execs
  22. def exec(actionBuilder: ActionBuilder): B
    Definition Classes
    Execs
  23. def exec(sessionFunction: Expression[Session]): B
    Definition Classes
    Execs
  24. def exitBlockOnFail(chain: ChainBuilder): B
    Definition Classes
    Errors
  25. def exitHere: B
    Definition Classes
    Errors
  26. def exitHereIf(condition: Expression[Boolean]): B
    Definition Classes
    Errors
  27. def exitHereIfFailed: B
    Definition Classes
    Errors
  28. 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
  29. 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
  30. 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
  31. 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
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def foreach(seq: Expression[Seq[Any]], attributeName: String, counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  34. def forever(counterName: String = UUID.randomUUID.toString, exitASAP: Boolean = false)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  35. def forever(chain: ChainBuilder): B
    Definition Classes
    Loops
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. def group(name: Expression[String])(chain: ChainBuilder): B
    Definition Classes
    Groups
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. def pace(duration: Expression[FiniteDuration], counter: String): B
    Definition Classes
    Pauses
  44. def pace(duration: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  45. def pace(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  46. def pace(min: String, max: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  47. def pace(min: FiniteDuration, max: FiniteDuration): B
    Definition Classes
    Pauses
  48. def pace(duration: String, unit: TimeUnit = TimeUnit.SECONDS): B
    Definition Classes
    Pauses
    Annotations
    @SuppressWarnings()
  49. def pace(duration: FiniteDuration): B
    Definition Classes
    Pauses
  50. def pause(duration: Expression[FiniteDuration], force: PauseType): B
    Definition Classes
    Pauses
  51. def pause(duration: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  52. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration], force: PauseType): B
    Definition Classes
    Pauses
  53. def pause(min: Expression[FiniteDuration], max: Expression[FiniteDuration]): B
    Definition Classes
    Pauses
  54. def pause(min: String, max: String, unit: TimeUnit, force: PauseType): B
    Definition Classes
    Pauses
  55. def pause(min: String, max: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  56. def pause(min: FiniteDuration, max: FiniteDuration, force: PauseType): B
    Definition Classes
    Pauses
  57. def pause(min: FiniteDuration, max: FiniteDuration): B
    Definition Classes
    Pauses
  58. def pause(duration: String, unit: TimeUnit, force: PauseType): B
    Definition Classes
    Pauses
  59. def pause(duration: String, unit: TimeUnit): B
    Definition Classes
    Pauses
  60. def pause(duration: String, force: PauseType): B
    Definition Classes
    Pauses
  61. def pause(duration: String): B
    Definition Classes
    Pauses
  62. def pause(duration: FiniteDuration, force: PauseType): B
    Definition Classes
    Pauses
  63. 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
  64. def randomSwitch(possibilities: (Double, ChainBuilder)*): 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
  65. def randomSwitchOrElse(possibilities: (Double, ChainBuilder)*)(elseNext: ChainBuilder): 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

    elseNext

    fallback subchain

    returns

    a new builder with a random switch added to its actions

    Definition Classes
    ConditionalStatements
  66. def rendezVous(users: Int): B
    Definition Classes
    Pauses
  67. def repeat(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): B
    Definition Classes
    Loops
    Annotations
    @SuppressWarnings()
  68. def roundRobinSwitch(possibilities: ChainBuilder*): 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
  69. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. def tryMax(times: Expression[Int], counterName: String = UUID.randomUUID.toString)(chain: ChainBuilder): B
    Definition Classes
    Errors
    Annotations
    @SuppressWarnings()
  72. def uniformRandomSwitch(possibilities: ChainBuilder*): 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
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

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