import JvmCounterBuilder = io.gatling.javaapi.core.CounterBuilder;
import JvmPerUserCounterBuilder = io.gatling.javaapi.core.PerUserCounterBuilder;
import { Wrapper } from "./common";
import { SessionTo } from "./session";
/**
 * Builder of an action that stores an incrementing value into the virtual users' Session.
 *
 * Immutable, so all methods return a new occurrence and leave the original unmodified.
 */
export interface CounterBuilder extends Wrapper<JvmCounterBuilder> {
    /**
     * Set the first value to be emitted. Must be positive. Default is 0.
     *
     * @param start - the first value
     * @returns a new CounterBuilder
     */
    startingAt(start: number): CounterBuilder;
    /**
     * Set the gap between 2 successive values. Default is 1.
     *
     * @param increment - the gap between 2 successive values
     * @returns a new CounterBuilder
     */
    withIncrement(increment: number): CounterBuilder;
    /**
     * Set the inclusive upper bound. Default is Integer.MAX_VALUE. Once it's reached, the load
     * generator is stopped, unless {@link wrapAround} is used.
     *
     * @param end - the inclusive upper bound
     * @returns a new CounterBuilder
     */
    upTo(end: number): CounterBuilder;
    /**
     * Start over from the first value once the upper bound is reached, instead of stopping the load
     * generator. Beware values are then no longer unique.
     *
     * @returns a new CounterBuilder
     */
    wrapAround(): CounterBuilder;
    /**
     * Track the counter independently for each virtual user, so they all get the very same sequence
     * of values, instead of sharing one single sequence.
     *
     * @returns a new CounterBuilder
     */
    perUser(): PerUserCounterBuilder;
    /**
     * Distribute the values evenly amongst all the load generators of a Gatling Enterprise cluster,
     * so they remain unique cluster wide. Only effective when the test is running with Gatling
     * Enterprise, noop otherwise. Each load generator only gets a slice of the range, so the values
     * emitted by the whole cluster have holes.
     *
     * @returns a new CounterBuilder
     */
    shard(): CounterBuilder;
}
/**
 * Builder of an action that stores an incrementing value into the virtual users' Session, tracked
 * independently for each virtual user. Only reachable from {@link CounterBuilder.perUser}, as
 * dynamic values, eg functions and Gatling EL Strings, only make sense when tracking per user: a
 * range resolved from one virtual user's Session can't define the sequence shared by all of them.
 *
 * Immutable, so all methods return a new occurrence and leave the original unmodified.
 */
export interface PerUserCounterBuilder extends Wrapper<JvmPerUserCounterBuilder> {
    /**
     * Set the first value to be emitted. Must be positive. Default is 0.
     *
     * @param start - the first value
     * @returns a new PerUserCounterBuilder
     */
    startingAt(start: number): PerUserCounterBuilder;
    /**
     * Set the first value to be emitted. Must be positive. Default is 0.
     *
     * @param start - the first value, as a Gatling EL String
     * @returns a new PerUserCounterBuilder
     */
    startingAt(start: string): PerUserCounterBuilder;
    /**
     * Set the first value to be emitted. Must be positive. Default is 0.
     *
     * @param start - the first value, as a function
     * @returns a new PerUserCounterBuilder
     */
    startingAt(start: SessionTo<number>): PerUserCounterBuilder;
    /**
     * Set the gap between 2 successive values. Default is 1.
     *
     * @param increment - the gap between 2 successive values
     * @returns a new PerUserCounterBuilder
     */
    withIncrement(increment: number): PerUserCounterBuilder;
    /**
     * Set the gap between 2 successive values. Default is 1.
     *
     * @param increment - the gap between 2 successive values, as a Gatling EL String
     * @returns a new PerUserCounterBuilder
     */
    withIncrement(increment: string): PerUserCounterBuilder;
    /**
     * Set the gap between 2 successive values. Default is 1.
     *
     * @param increment - the gap between 2 successive values, as a function
     * @returns a new PerUserCounterBuilder
     */
    withIncrement(increment: SessionTo<number>): PerUserCounterBuilder;
    /**
     * Set the upper bound, exclusive, except when it's Integer.MAX_VALUE, which is the default. Once
     * it's reached, the load generator is stopped, unless {@link #wrapAround()} is used.
     *
     * @param end - the exclusive upper bound
     * @returns a new PerUserCounterBuilder
     */
    upTo(end: number): PerUserCounterBuilder;
    /**
     * Set the upper bound, exclusive, except when it's Integer.MAX_VALUE, which is the default. Once
     * it's reached, the load generator is stopped, unless {@link #wrapAround()} is used.
     *
     * @param end - the exclusive upper bound, as a Gatling EL String
     * @returns a new PerUserCounterBuilder
     */
    upTo(end: string): PerUserCounterBuilder;
    /**
     * Set the upper bound, exclusive, except when it's Integer.MAX_VALUE, which is the default. Once
     * it's reached, the load generator is stopped, unless {@link #wrapAround()} is used.
     *
     * @param end - the exclusive upper bound, as a function
     * @returns a new PerUserCounterBuilder
     */
    upTo(end: SessionTo<number>): PerUserCounterBuilder;
    /**
     * Start over from the first value once the upper bound is reached, instead of stopping the load
     * generator. Beware values are then no longer unique.
     *
     * @returns a new PerUserCounterBuilder
     */
    wrapAround(): PerUserCounterBuilder;
}
/**
 * Bootstrap a builder for an action that stores an incrementing value into the virtual users' Session. Values are
 * shared amongst all the virtual users of this load generator, unless {@link CounterBuilder.perUser } is used.
 *
 * @param key - the name of the Session attribute the value is stored into
 * @returns a new CounterBuilder
 */
export declare const counter: (key: string) => CounterBuilder;