
public class PactDslResponse

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final PactSpecVersion`	`version`

Constructor Summary

Constructors
Constructor	Description
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments, PactSpecVersion version, Map<String, JsonValue> additionalMetadata)`
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments, PactSpecVersion version)`
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments)`
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues)`
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues)`
`PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request)`

Method Summary

Modifier and Type	Method	Description
`final PactSpecVersion`	`getVersion()`
`final PactDslResponse`	`status(Integer status)`	Response status code
`final PactDslResponse`	`headers(Map<String, String> headers)`	Response headers to returnProvide the headers you want to validate, other headers will be ignored.
`final PactDslResponse`	`body(String body)`	Response body to return
`final PactDslResponse`	`body(String body, String contentType)`	Response body to return
`final PactDslResponse`	`body(String body, ContentType contentType)`	Response body to return
`final PactDslResponse`	`body(Supplier<String> body)`	The body of the request
`final PactDslResponse`	`body(Supplier<String> body, String contentType)`	The body of the request
`final PactDslResponse`	`body(Supplier<String> body, ContentType contentType)`	The body of the request
`final PactDslResponse`	`body(JSONObject body)`	Response body to return
`final PactDslResponse`	`body(DslPart body)`	Response body to return
`final PactDslResponse`	`body(Document body)`	Response body to return
`final PactDslResponse`	`body(PactXmlBuilder xmlBuilder)`	XML Response body to return
`final PactDslResponse`	`bodyWithSingleQuotes(String body)`	The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
`final PactDslResponse`	`bodyWithSingleQuotes(String body, String contentType)`	The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
`final PactDslResponse`	`bodyWithSingleQuotes(String body, ContentType contentType)`	The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
`final PactDslResponse`	`withBinaryData(ByteArray example, String contentType)`	Response body as a binary data.
`final PactDslResponse`	`matchHeader(String header, String regexp, String headerExample)`	Match a response header.
`final PactDslResponse`	`matchHeader(String header, String regexp)`	Match a response header.
`final <P extends BasePact> P`	`toPact(Class<P> pactClass)`	Terminates the DSL and builds a pact to represent the interactions
`final RequestResponsePact`	`toPact()`	Terminates the DSL and builds a pact to represent the interactions
`final PactDslRequestWithPath`	`uponReceiving(String description)`	Description of the request that is expected to be received
`final PactDslWithState`	`given(String state)`	Adds a provider state to this interaction
`final PactDslWithState`	`given(String state, Map<String, Object> params)`	Adds a provider state to this interaction
`final PactDslResponse`	`headerFromProviderState(String name, String expression, String example)`	Adds a header that will have it's value injected from the provider state
`final PactDslResponse`	`matchSetCookie(String cookie, String regex, String example)`	Match a set cookie header
`final PactDslResponse`	`comment(String comment)`	Adds a comment to this interaction
`final PactDslResponse`	`informationStatus()`	Match any HTTP Information response status (100-199)
`final PactDslResponse`	`successStatus()`	Match any HTTP success response status (200-299)
`final PactDslResponse`	`redirectStatus()`	Match any HTTP redirect response status (300-399)
`final PactDslResponse`	`clientErrorStatus()`	Match any HTTP client error response status (400-499)
`final PactDslResponse`	`serverErrorStatus()`	Match any HTTP server error response status (500-599)
`final PactDslResponse`	`nonErrorStatus()`	Match any HTTP non-error response status (< 400)
`final PactDslResponse`	`errorStatus()`	Match any HTTP error response status (>= 400)
`final PactDslResponse`	`statusCodes(List<Integer> statusCodes)`	Match any HTTP status code in the provided list
`final PactDslResponse`	`addMetadataValue(String key, String value)`	Adds additional values to the metadata section of the Pact file
`final PactDslResponse`	`addMetadataValue(String key, JsonValue value)`	Adds additional values to the metadata section of the Pact file

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

- Constructor Detail
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments, PactSpecVersion version, Map<String, JsonValue> additionalMetadata)
```
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments, PactSpecVersion version)
```
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments)
```
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues)
```
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues)
```
  - PactDslResponse
```
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request)
```
- Method Detail
  - getVersion
```
 final PactSpecVersion getVersion()
```
  - status
```
 final PactDslResponse status(Integer status)
```
    Response status code
    
    Parameters:
    
    status - HTTP status code
  - headers
```
 final PactDslResponse headers(Map<String, String> headers)
```
    Response headers to return
    Provide the headers you want to validate, other headers will be ignored.
    
    Parameters:
    
    headers - key-value pairs of headers
  - body
```
 final PactDslResponse body(String body)
```
    Response body to return
    
    Parameters:
    
    body - Response body in string form
  - body
```
 final PactDslResponse body(String body, String contentType)
```
    Response body to return
    
    Parameters:
    
    body - body in string form
    
    contentType - the Content-Type response header value
  - body
```
 final PactDslResponse body(String body, ContentType contentType)
```
    Response body to return
    
    Parameters:
    
    body - body in string form
    
    contentType - the Content-Type response header value
  - body
```
 final PactDslResponse body(Supplier<String> body)
```
    The body of the request
    
    Parameters:
    
    body - Response body in Java Functional Interface Supplier that must return a string
  - body
```
 final PactDslResponse body(Supplier<String> body, String contentType)
```
    The body of the request
    
    Parameters:
    
    body - Response body in Java Functional Interface Supplier that must return a string
    
    contentType - the Content-Type response header value
  - body
```
 final PactDslResponse body(Supplier<String> body, ContentType contentType)
```
    The body of the request
    
    Parameters:
    
    body - Response body in Java Functional Interface Supplier that must return a string
    
    contentType - the Content-Type response header value
  - body
```
 final PactDslResponse body(JSONObject body)
```
    Response body to return
    
    Parameters:
    
    body - Response body in JSON form
  - body
```
 final PactDslResponse body(DslPart body)
```
    Response body to return
    
    Parameters:
    
    body - Response body built using the Pact body DSL
  - body
```
 final PactDslResponse body(Document body)
```
    Response body to return
    
    Parameters:
    
    body - Response body as an XML Document
  - body
```
 final PactDslResponse body(PactXmlBuilder xmlBuilder)
```
    XML Response body to return
    
    Parameters:
    
    xmlBuilder - XML Builder used to construct the XML document
  - bodyWithSingleQuotes
```
 final PactDslResponse bodyWithSingleQuotes(String body)
```
    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
    
    Parameters:
    
    body - Request body in string form
  - bodyWithSingleQuotes
```
 final PactDslResponse bodyWithSingleQuotes(String body, String contentType)
```
    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
    
    Parameters:
    
    body - Request body in string form
    
    contentType - the Content-Type response header value
  - bodyWithSingleQuotes
```
 final PactDslResponse bodyWithSingleQuotes(String body, ContentType contentType)
```
    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
    
    Parameters:
    
    body - Request body in string form
    
    contentType - the Content-Type response header value
  - withBinaryData
```
 final PactDslResponse withBinaryData(ByteArray example, String contentType)
```
    Response body as a binary data. It will match any expected bodies against the content type.
    
    Parameters:
    
    example - Example contents to use in the consumer test
    
    contentType - Content type of the data
  - matchHeader
```
@JvmOverloads() final PactDslResponse matchHeader(String header, String regexp, String headerExample)
```
    Match a response header. A random example header value will be generated from the provided regular expression if the example value is not provided.
    
    Parameters:
    
    header - Header to match
    
    regexp - Regular expression to match
    
    headerExample - Example value to use
  - matchHeader
```
@JvmOverloads() final PactDslResponse matchHeader(String header, String regexp)
```
    Match a response header. A random example header value will be generated from the provided regular expression if the example value is not provided.
    
    Parameters:
    
    header - Header to match
    
    regexp - Regular expression to match
  - toPact
```
 final <P extends BasePact> P toPact(Class<P> pactClass)
```
    Terminates the DSL and builds a pact to represent the interactions
  - toPact
```
 final RequestResponsePact toPact()
```
    Terminates the DSL and builds a pact to represent the interactions
  - uponReceiving
```
 final PactDslRequestWithPath uponReceiving(String description)
```
    Description of the request that is expected to be received
    
    Parameters:
    
    description - request description
  - given
```
 final PactDslWithState given(String state)
```
    Adds a provider state to this interaction
    
    Parameters:
    
    state - Description of the state
  - given
```
 final PactDslWithState given(String state, Map<String, Object> params)
```
    Adds a provider state to this interaction
    
    Parameters:
    
    state - Description of the state
    
    params - Data parameters for this state
  - headerFromProviderState
```
 final PactDslResponse headerFromProviderState(String name, String expression, String example)
```
    Adds a header that will have it's value injected from the provider state
    
    Parameters:
    
    name - Header Name
    
    expression - Expression to be evaluated from the provider state
    
    example - Example value to use in the consumer test
  - matchSetCookie
```
 final PactDslResponse matchSetCookie(String cookie, String regex, String example)
```
    Match a set cookie header
    
    Parameters:
    
    cookie - Cookie name to match
    
    regex - Regex to match the cookie value with
    
    example - Example value
  - comment
```
 final PactDslResponse comment(String comment)
```
    Adds a comment to this interaction
  - informationStatus
```
 final PactDslResponse informationStatus()
```
    Match any HTTP Information response status (100-199)
  - successStatus
```
 final PactDslResponse successStatus()
```
    Match any HTTP success response status (200-299)
  - redirectStatus
```
 final PactDslResponse redirectStatus()
```
    Match any HTTP redirect response status (300-399)
  - clientErrorStatus
```
 final PactDslResponse clientErrorStatus()
```
    Match any HTTP client error response status (400-499)
  - serverErrorStatus
```
 final PactDslResponse serverErrorStatus()
```
    Match any HTTP server error response status (500-599)
  - nonErrorStatus
```
 final PactDslResponse nonErrorStatus()
```
    Match any HTTP non-error response status (< 400)
  - errorStatus
```
 final PactDslResponse errorStatus()
```
    Match any HTTP error response status (>= 400)
  - statusCodes
```
 final PactDslResponse statusCodes(List<Integer> statusCodes)
```
    Match any HTTP status code in the provided list
  - addMetadataValue
```
 final PactDslResponse addMetadataValue(String key, String value)
```
    Adds additional values to the metadata section of the Pact file
  - addMetadataValue
```
 final PactDslResponse addMetadataValue(String key, JsonValue value)
```
    Adds additional values to the metadata section of the Pact file

Class PactDslResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PactDslResponse

PactDslResponse

PactDslResponse

PactDslResponse

PactDslResponse

PactDslResponse

Method Detail

getVersion

status

headers

body

body

body

body

body

body

body

body

body

body

bodyWithSingleQuotes

bodyWithSingleQuotes

bodyWithSingleQuotes

withBinaryData

matchHeader

matchHeader

toPact

toPact

uponReceiving

given

given

headerFromProviderState

matchSetCookie

comment

informationStatus

successStatus

redirectStatus

clientErrorStatus

serverErrorStatus

nonErrorStatus

errorStatus

statusCodes

addMetadataValue

addMetadataValue