ConsumerPactDsl 4.7.1 API

All Implemented Interfaces:
```
public final class ConsumerPactDsl

                    
```
Receiver for the top-level pact DSL block. Accumulates interactions and pact-level settings.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`ConsumerPactDsl(String consumer, String provider)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Unit`	`usingPlugin(String name, String version)`	Enables a Pact plugin by name.
`final Unit`	`addMetadata(String key, String value)`	Adds an entry to the metadata section of the Pact file.
`final Unit`	`comment(String comment)`	Adds a text comment.
`final Unit`	`given(String state, Map<String, Object> params)`	Describes the provider state required for the next interaction.
`final Unit`	`given(String state, Pair<String, Object> params)`	Describes the provider state required for the next interaction with key/value parameters.
`final Unit`	`uponReceiving(String description, Function1<HttpInteractionDsl, Unit> block)`	Defines an HTTP interaction using a BDD-style description.
`final Unit`	`interaction(String description, Function1<HttpInteractionDsl, Unit> block)`	Defines an HTTP interaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConsumerPactDsl
```
ConsumerPactDsl(String consumer, String provider)
```
- Method Detail
  - usingPlugin
```
 final Unit usingPlugin(String name, String version)
```
    Enables a Pact plugin by name. Optionally pins a specific version.
  - addMetadata
```
 final Unit addMetadata(String key, String value)
```
    Adds an entry to the metadata section of the Pact file.
  - comment
```
 final Unit comment(String comment)
```
    Adds a text comment. The comment is attached to the next interaction.
  - given
```
 final Unit given(String state, Map<String, Object> params)
```
    Describes the provider state required for the next interaction. May be called multiple times. Parameters will be applied to the next uponReceiving or interaction block.
  - given
```
 final Unit given(String state, Pair<String, Object> params)
```
    Describes the provider state required for the next interaction with key/value parameters.
  - uponReceiving
```
 final Unit uponReceiving(String description, Function1<HttpInteractionDsl, Unit> block)
```
    Defines an HTTP interaction using a BDD-style description. Equivalent to interaction.
  - interaction
```
 final Unit interaction(String description, Function1<HttpInteractionDsl, Unit> block)
```
    Defines an HTTP interaction. The block configures the expected request and response.