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

Interface HttpResponseExample

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpResponseExample.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpResponseExample.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	getStatus()	Any test-equivalence matcher, string, or number for the HTTP status code accepted by this example (Recommended: Use the HttpStatusCode matcher).
default String	getUniqueName()	What unique name, if any, to give to this response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStatus

@Stability(Stable)
@NotNull
Object getStatus()

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

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

getUniqueName

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

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

builder

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

Returns:

a HttpResponseExample.Builder of HttpResponseExample