mockzilla-common/com.apadmi.mockzilla.lib.models/EndpointConfiguration/Builder

Builder

class Builder(key: String)

Parameters

key

An identifier for this endpoint. Endpoints cannot share an id.

Constructors

Builder

constructor(key: String)

Functions

build

fun build(): EndpointConfiguration

Completes the builder - returns the configuration.

configureDashboardOverrides

fun configureDashboardOverrides(action: DashboardOptionsConfig.Builder.() -> DashboardOptionsConfig.Builder): EndpointConfiguration.Builder

Configure the presets that are available to users of the dashboard.

setDefaultHandler

fun setDefaultHandler(handler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse): EndpointConfiguration.Builder

The block called when a network request is made to this endpoint. Note: If the value of setShouldFail causes Mockzilla to generate a failure response, then this block will not be called, instead the block specified by setErrorHandler is called.

setDelayMillis

fun setDelayMillis(delay: Int): EndpointConfiguration.Builder

Used to simulate latency: The artificial delay Mockzilla with add to the network request.

setErrorHandler

fun setErrorHandler(handler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse): EndpointConfiguration.Builder

The block called when a network request is made to this endpoint but Mockzilla decides to simulate a server failure.

setFailureProbability

fun ~~setFailureProbability~~(percentage: Int): EndpointConfiguration.Builder

Probability of Mockzilla returning a simulated http error for this endpoint. 100 being a guaranteed error .

setMeanDelayMillis

fun ~~setMeanDelayMillis~~(delay: Int): EndpointConfiguration.Builder

Used to simulate latency: The artificial mean delay Mockzilla with add to a network request.

setName

fun setName(name: String): EndpointConfiguration.Builder

Sets the human readable name of the endpoint (defaults to the value of the key)

setPattern

fun setPattern(regex: String): EndpointConfiguration.Builder

Specifies whether Mockzilla should map a network request to this endpoint.

setPatternMatcher

fun setPatternMatcher(matcher: suspend MockzillaHttpRequest.() -> Boolean): EndpointConfiguration.Builder

Specifies whether Mockzilla should map a network request to this endpoint.

setShouldFail

fun setShouldFail(shouldFail: Boolean): EndpointConfiguration.Builder

Controls whether calls to this endpoint should fail by default

setVersionCode

fun setVersionCode(code: Int): EndpointConfiguration.Builder

Sets the version this endpoint is currently set to. A change in the version code will automatically clear any caches on the device associated with this endpoint.