Package io.contract_testing.contractcase.definitions.matchers.http

Class HttpResponseExample.Builder

java.lang.Object

io.contract_testing.contractcase.definitions.matchers.http.HttpResponseExample.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpResponseExample>

Enclosing interface:

HttpResponseExample

@Stability(Stable)
public static final class HttpResponseExample.Builder
extends Object
implements software.amazon.jsii.Builder<HttpResponseExample>

A builder for HttpResponseExample

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpResponseExample.Builder	body(Object body)	Sets the value of HttpResponseExample.getBody()
HttpResponseExample	build()	Builds the configured instance.
HttpResponseExample.Builder	headers(Object headers)	Sets the value of HttpResponseExample.getHeaders()
HttpResponseExample.Builder	status(Object status)	Sets the value of HttpResponseExample.getStatus()
HttpResponseExample.Builder	uniqueName(String uniqueName)	Sets the value of HttpResponseExample.getUniqueName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

status

@Stability(Stable)
public HttpResponseExample.Builder status(Object status)

Sets the value of HttpResponseExample.getStatus()

Parameters:

status - Any test-equivalence matcher, string, or number for the HTTP status code accepted by this example (Recommended: Use the HttpStatusCode matcher). This parameter is required.

Returns:

this

body

@Stability(Stable)
public HttpResponseExample.Builder body(Object body)

Sets the value of HttpResponseExample.getBody()

Parameters:

body - A test equivalence matcher or json object that describes the body for this response. If not provided, no body matching is performed.

Returns:

this

headers

@Stability(Stable)
public HttpResponseExample.Builder headers(Object headers)

Sets the value of HttpResponseExample.getHeaders()

Parameters:

headers - A Map of header names and associated test-equivalence matcher values accepted by this example. If not provided, no header matching is performed

Returns:

this

uniqueName

@Stability(Stable)
public HttpResponseExample.Builder uniqueName(String uniqueName)

Sets the value of HttpResponseExample.getUniqueName()

Parameters:

uniqueName - What unique name, if any, to give to this response.

Returns:

this

build

@Stability(Stable)
public HttpResponseExample build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpResponseExample>

Returns:

a new instance of HttpResponseExample

Throws:

NullPointerException - if any required attribute was not provided