Packages

c

au.com.dius.pact.consumer.dsl

PactDslRequestWithPath

class PactDslRequestWithPath extends PactDslRequestBase

Linear Supertypes
PactDslRequestBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PactDslRequestWithPath
  2. PactDslRequestBase
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def body(body: Document): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    XML Document

  6. def body(body: DslPart): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Built using the Pact body DSL

  7. def body(body: JSONObject): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in JSON form

  8. def body(body: Supplier[String], contentType: ContentType): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in Java Functional Interface Supplier that must return a string

  9. def body(body: Supplier[String], contentType: String): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in Java Functional Interface Supplier that must return a string

  10. def body(body: Supplier[String]): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in Java Functional Interface Supplier that must return a string

  11. def body(body: String, contentType: ContentType): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in string form

  12. def body(body: String, contentType: String): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in string form

  13. def body(body: String): PactDslRequestWithPath

    The body of the request

    The body of the request

    body

    Request body in string form

  14. def bodyWithSingleQuotes(body: String, contentType: ContentType): PactDslRequestWithPath

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    body

    Request body in string form

  15. def bodyWithSingleQuotes(body: String, contentType: String): PactDslRequestWithPath

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    body

    Request body in string form

  16. def bodyWithSingleQuotes(body: String): PactDslRequestWithPath

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

    body

    Request body in string form

  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  18. def encodedQuery(query: String): PactDslRequestWithPath

    The encoded query string for the request

    The encoded query string for the request

    query

    query string

  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def headerFromProviderState(name: String, expression: String, example: String): PactDslRequestWithPath

    Adds a header that will have it's value injected from the provider state

    Adds a header that will have it's value injected from the provider state

    name

    Header Name

    expression

    Expression to be evaluated from the provider state

    example

    Example value to use in the consumer test

  25. def headers(headers: Map[String, String]): PactDslRequestWithPath

    Headers to be included in the request

    Headers to be included in the request

    headers

    Key-value pairs

  26. def headers(firstHeaderName: String, firstHeaderValue: String, headerNameValuePairs: <repeated...>[String]): PactDslRequestWithPath

    Headers to be included in the request

    Headers to be included in the request

    firstHeaderName

    The name of the first header

    firstHeaderValue

    The value of the first header

    headerNameValuePairs

    Additional headers in name-value pairs.

  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def matchHeader(header: String, regex: String, headerExample: String): PactDslRequestWithPath

    Match a request header.

    Match a request header.

    header

    Header to match

    regex

    Regular expression to match

    headerExample

    Example value to use

  29. def matchHeader(header: String, regex: String): PactDslRequestWithPath

    Match a request header.

    Match a request header. A random example header value will be generated from the provided regular expression.

    header

    Header to match

    regex

    Regular expression to match

  30. def matchPath(pathRegex: String, path: String): PactDslRequestWithPath

    The path of the request

    The path of the request

    pathRegex

    regular expression to use to match paths

    path

    string path to use when generating requests

  31. def matchPath(pathRegex: String): PactDslRequestWithPath

    The path of the request.

    The path of the request. This will generate a random path to use when generating requests

    pathRegex

    string path regular expression to match with

  32. def matchQuery(parameter: String, regex: String, example: List[String]): PactDslRequestWithPath

    Match a repeating query parameter with a regex.

    Match a repeating query parameter with a regex.

    parameter

    Query parameter

    regex

    Regular expression to match with each element

    example

    Example value list to use for the query parameter (unencoded)

  33. def matchQuery(parameter: String, regex: String, example: String): PactDslRequestWithPath

    Match a query parameter with a regex.

    Match a query parameter with a regex.

    parameter

    Query parameter

    regex

    Regular expression to match with

    example

    Example value to use for the query parameter (unencoded)

  34. def matchQuery(parameter: String, regex: String): PactDslRequestWithPath

    Match a query parameter with a regex.

    Match a query parameter with a regex. A random query parameter value will be generated from the regex.

    parameter

    Query parameter

    regex

    Regular expression to match with

  35. def method(method: String): PactDslRequestWithPath

    The HTTP method for the request

    The HTTP method for the request

    method

    Valid HTTP method

  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def path(path: String): PactDslRequestWithPath

    The path of the request

    The path of the request

    path

    string path

  40. def pathFromProviderState(expression: String, example: String): PactDslRequestWithPath

    Sets the path to have it's value injected from the provider state

    Sets the path to have it's value injected from the provider state

    expression

    Expression to be evaluated from the provider state

    example

    Example value to use in the consumer test

  41. def query(query: String): PactDslRequestWithPath

    The query string for the request

    The query string for the request

    query

    query string

  42. def queryMatchingDate(field: String, pattern: String): PactDslRequestWithPath

    Matches a date field using the provided date pattern.

    Matches a date field using the provided date pattern. The current system date will be used for the example value.

    field

    field name

    pattern

    pattern to match

  43. def queryMatchingDate(field: String, pattern: String, example: String): PactDslRequestWithPath

    Matches a date field using the provided date pattern

    Matches a date field using the provided date pattern

    field

    field name

    pattern

    pattern to match

    example

    Example value

  44. def queryMatchingDateBase(field: String, pattern: String, example: String): PactDslRequestBase
    Attributes
    protected[au.com.dius.pact.consumer.dsl]
    Definition Classes
    PactDslRequestBase
  45. def queryMatchingDatetime(field: String, pattern: String): PactDslRequestWithPath

    Matches a datetime field using the provided pattern.

    Matches a datetime field using the provided pattern. The current system date and time will be used for the example value.

    field

    field name

    pattern

    pattern to match

  46. def queryMatchingDatetime(field: String, pattern: String, example: String): PactDslRequestWithPath

    Matches a datetime field using the provided pattern

    Matches a datetime field using the provided pattern

    field

    field name

    pattern

    pattern to match

    example

    Example value

  47. def queryMatchingDatetimeBase(field: String, pattern: String, example: String): PactDslRequestBase
    Attributes
    protected[au.com.dius.pact.consumer.dsl]
    Definition Classes
    PactDslRequestBase
  48. def queryMatchingISODate(field: String): PactDslRequestWithPath

    Matches a date field using the ISO date pattern.

    Matches a date field using the ISO date pattern. The current system date will be used for the example value.

    field

    field name

  49. def queryMatchingISODate(field: String, example: String): PactDslRequestWithPath

    Matches a date field using the ISO date pattern

    Matches a date field using the ISO date pattern

    field

    field name

    example

    Example value

  50. def queryMatchingISODatetime(field: String): PactDslRequestWithPath

    Matches a datetime field using the ISO pattern.

    Matches a datetime field using the ISO pattern. The current system date and time will be used for the example value.

    field

    field name

  51. def queryMatchingISODatetime(field: String, example: String): PactDslRequestWithPath

    Matches a datetime field using the ISO pattern

    Matches a datetime field using the ISO pattern

    field

    field name

    example

    Example value

  52. def queryMatchingISOTime(field: String, example: String): PactDslRequestWithPath

    Matches a time field using the ISO time pattern

    Matches a time field using the ISO time pattern

    field

    field name

    example

    Example value

  53. def queryMatchingTime(field: String): PactDslRequestWithPath

    Matches a time field using the ISO time pattern.

    Matches a time field using the ISO time pattern. The current system time will be used for the example value.

    field

    field name

  54. def queryMatchingTime(field: String, pattern: String): PactDslRequestWithPath

    Matches a time field using the provided time pattern.

    Matches a time field using the provided time pattern. The current system time will be used for the example value.

    field

    field name

    pattern

    pattern to match

  55. def queryMatchingTime(field: String, pattern: String, example: String): PactDslRequestWithPath

    Matches a time field using the provided time pattern

    Matches a time field using the provided time pattern

    field

    field name

    pattern

    pattern to match

    example

    Example value

  56. def queryMatchingTimeBase(field: String, pattern: String, example: String): PactDslRequestBase
    Attributes
    protected[au.com.dius.pact.consumer.dsl]
    Definition Classes
    PactDslRequestBase
  57. def queryParameterFromProviderState(name: String, expression: String, example: String): PactDslRequestWithPath

    Adds a query parameter that will have it's value injected from the provider state

    Adds a query parameter that will have it's value injected from the provider state

    name

    Name

    expression

    Expression to be evaluated from the provider state

    example

    Example value to use in the consumer test

  58. def setupDefaultValues(): Unit
    Attributes
    protected[au.com.dius.pact.consumer.dsl]
    Definition Classes
    PactDslRequestBase
  59. def setupFileUpload(partName: String, fileName: String, fileContentType: String, data: Array[Byte]): Unit
    Attributes
    protected[au.com.dius.pact.consumer.dsl]
    Definition Classes
    PactDslRequestBase
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  65. def willRespondWith(): PactDslResponse

    Define the response to return

  66. def withFileUpload(partName: String, fileName: String, fileContentType: String, data: Array[Byte]): PactDslRequestWithPath

    Sets up a file upload request.

    Sets up a file upload request. This will add the correct content type header to the request

    partName

    This is the name of the part in the multipart body.

    fileName

    This is the name of the file that was uploaded

    fileContentType

    This is the content type of the uploaded file

    data

    This is the actual file contents

Inherited from PactDslRequestBase

Inherited from AnyRef

Inherited from Any

Ungrouped