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

Class HttpRequest

java.lang.Object

software.amazon.jsii.JsiiObject

io.contract_testing.contractcase.definitions.matchers.base.AnyMatcher

io.contract_testing.contractcase.definitions.matchers.http.HttpRequest

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-08-20T01:46:20.843Z")
@Stability(Stable)
public class HttpRequest
extends AnyMatcher

Matches any HTTP Request with the provided properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRequest.Builder	A fluent builder for HttpRequest.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpRequest(HttpRequestExample requestExample)	Matches any HTTP Request with the provided properties.
protected	HttpRequest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpRequest(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Object	getBody()
Object	getHeaders()
Object	getMethod()
Object	getPath()
Object	getQuery()
String	getUniqueName()
Object	toJSON()	For non-TypeScript implementations (see AnyMatcher.toJSON).

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpRequest

protected HttpRequest(software.amazon.jsii.JsiiObjectRef objRef)

HttpRequest

protected HttpRequest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpRequest

@Stability(Stable)
public HttpRequest(@NotNull
                   HttpRequestExample requestExample)

Matches any HTTP Request with the provided properties.

Parameters:

requestExample -

• An HttpResponseExample that describes the response.

This parameter is required.

Method Detail

toJSON

@Stability(Stable)
@NotNull
public Object toJSON()

For non-TypeScript implementations (see AnyMatcher.toJSON).

Overrides:

toJSON in class AnyMatcher

Returns:

An object in the matcher format described {@link https://case.contract-testing.io/docs/reference/plugin-framework in the Extending ContractCase documentation}

getMethod

@Stability(Stable)
@NotNull
public Object getMethod()

getPath

@Stability(Stable)
@NotNull
public Object getPath()

getBody

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

getHeaders

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

getQuery

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

getUniqueName

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