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

Interface HttpRequestExample

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpRequestExample.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-08-20T01:46:20.844Z")
@Stability(Stable)
public interface HttpRequestExample
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpRequestExample.Builder	A builder for HttpRequestExample
static class	HttpRequestExample.Jsii$Proxy	An implementation for HttpRequestExample

Method Summary

Modifier and Type	Method	Description
static HttpRequestExample.Builder	builder()
default Object	getBody()	A test equivalence matcher or json object that describes the body for this response.
default Object	getHeaders()	A Map of header names and associated test-equivalence matcher values accepted by this example.
Object	getMethod()	A string or string matcher that matches the method used for this example (eg "GET" or "POST").
Object	getPath()	A string or string matcher that matches the path of this example.
default Object	getQuery()	A test-equivalence matcher for the query.
default String	getUniqueName()	What unique name, if any, to give to this request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMethod

@Stability(Stable)
@NotNull
Object getMethod()

A string or string matcher that matches the method used for this example (eg "GET" or "POST").

Case insensitive. Note that DELETE, GET and HEAD requests should not have bodies - see the HTTP RFCs for details.

getPath

@Stability(Stable)
@NotNull
Object getPath()

A string or string matcher that matches the path of this example.

Note that any query parameters must be in the query, not in the path.

getBody

@Stability(Stable)
@Nullable
default Object getBody()

A test equivalence matcher or json object that describes the body for this response.

If not provided, no body matching is performed.

getHeaders

@Stability(Stable)
@Nullable
default Object getHeaders()

A Map of header names and associated test-equivalence matcher values accepted by this example.

If not provided, no header matching is performed

getQuery

@Stability(Stable)
@Nullable
default Object getQuery()

A test-equivalence matcher for the query.

Usually this is a Map of test-equivalence matchers to match the parsed query string, keyed by parameter name. Repeated parameters are collated and put in an array in this map.

getUniqueName

@Stability(Stable)
@Nullable
default String getUniqueName()

What unique name, if any, to give to this request.

builder

@Stability(Stable)
static HttpRequestExample.Builder builder()

Returns:

a HttpRequestExample.Builder of HttpRequestExample