All Implemented Interfaces:: au.com.dius.pact.consumer.dsl.DslBuilder


public class PactBuilder
 implements DslBuilder

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`PactBuilder.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`consumer`
`private String`	`provider`
`private PactSpecVersion`	`pactVersion`

Constructor Summary

Constructors
Constructor	Description
`PactBuilder(String consumer, String provider, PactSpecVersion pactVersion)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getConsumer()`
`final Unit`	`setConsumer(String consumer)`
`final String`	`getProvider()`
`final Unit`	`setProvider(String provider)`
`final PactSpecVersion`	`getPactVersion()`
`final Unit`	`setPactVersion(PactSpecVersion pactVersion)`
`final PactDslWithProvider`	`usingLegacyDsl()`	Use the old HTTP Pact DSL
`final MessagePactBuilder`	`usingLegacyMessageDsl()`	Use the old HTTP Pact DSL
`final SynchronousMessagePactBuilder`	`usingSynchronousMessageDsl()`	Use the Synchronous Message DSL
`final Unit`	`pactSpecVersion(PactSpecVersion version)`	Sets the Pact specification version
`final PactBuilder`	`usingPlugin(String name, String version)`	Enable a plugin
`final PactBuilder`	`usingPlugin(String name)`	Enable a plugin
`final PactBuilder`	`expectsToReceive(String description, String interactionType, String key)`	Adds an interaction with the given description and type.
`final PactBuilder`	`expectsToReceive(String description, String interactionType)`	Adds an interaction with the given description and type.
`final PactBuilder`	`with(Map<String, Object> values)`	Values to configure the interaction
`Unit`	`addPluginConfiguration(ContentMatcher matcher, Map<String, JsonValue> pactConfiguration)`
`final PactBuilder`	`addMetadataValue(String key, String value)`	Adds additional values to the metadata section of the Pact file
`final PactBuilder`	`addMetadataValue(String key, JsonValue value)`	Adds additional values to the metadata section of the Pact file
`final V4Pact`	`toPact()`

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

Constructor Detail

PactBuilder

PactBuilder(String consumer, String provider, PactSpecVersion pactVersion)

Method Detail
- getConsumer
```
 final String getConsumer()
```
- setConsumer
```
 final Unit setConsumer(String consumer)
```
- getProvider
```
 final String getProvider()
```
- setProvider
```
 final Unit setProvider(String provider)
```
- getPactVersion
```
 final PactSpecVersion getPactVersion()
```
- setPactVersion
```
 final Unit setPactVersion(PactSpecVersion pactVersion)
```
- usingLegacyDsl
```
 final PactDslWithProvider usingLegacyDsl()
```
  Use the old HTTP Pact DSL
- usingLegacyMessageDsl
```
 final MessagePactBuilder usingLegacyMessageDsl()
```
  Use the old HTTP Pact DSL
- usingSynchronousMessageDsl
```
 final SynchronousMessagePactBuilder usingSynchronousMessageDsl()
```
  Use the Synchronous Message DSL
- pactSpecVersion
```
 final Unit pactSpecVersion(PactSpecVersion version)
```
  Sets the Pact specification version
- usingPlugin
```
@JvmOverloads() final PactBuilder usingPlugin(String name, String version)
```
  Enable a plugin
- usingPlugin
```
@JvmOverloads() final PactBuilder usingPlugin(String name)
```
  Enable a plugin
- expectsToReceive
```
@JvmOverloads() final PactBuilder expectsToReceive(String description, String interactionType, String key)
```
  Adds an interaction with the given description and type. If interactionType is not specified (is the empty string) will default to an HTTP interaction
  
  Parameters:
  
  description - The interaction description.
  
  interactionType - The key of the interaction type as found in the catalogue manager.
  
  key - (Optional) unique key to assign to the interaction
- expectsToReceive
```
@JvmOverloads() final PactBuilder expectsToReceive(String description, String interactionType)
```
  Adds an interaction with the given description and type. If interactionType is not specified (is the empty string) will default to an HTTP interaction
  
  Parameters:
  
  description - The interaction description.
  
  interactionType - The key of the interaction type as found in the catalogue manager.
- with
```
 final PactBuilder with(Map<String, Object> values)
```
  Values to configure the interaction
- addPluginConfiguration
```
 Unit addPluginConfiguration(ContentMatcher matcher, Map<String, JsonValue> pactConfiguration)
```
- addMetadataValue
```
 final PactBuilder addMetadataValue(String key, String value)
```
  Adds additional values to the metadata section of the Pact file
- addMetadataValue
```
 final PactBuilder addMetadataValue(String key, JsonValue value)
```
  Adds additional values to the metadata section of the Pact file
- toPact
```
 final V4Pact toPact()
```

Class PactBuilder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PactBuilder

Method Detail

getConsumer

setConsumer

getProvider

setProvider

getPactVersion

setPactVersion

usingLegacyDsl

usingLegacyMessageDsl

usingSynchronousMessageDsl

pactSpecVersion

usingPlugin

usingPlugin

expectsToReceive

expectsToReceive

with

addPluginConfiguration

addMetadataValue

addMetadataValue

toPact