Skip navigation links
A C D E F G H I L N O P R S T U W 

A

about(String) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
answeredBy(Actor) - Method in class net.serenitybdd.screenplay.rest.questions.LastResponse
 
answeredBy(Actor) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestion
 
answeredBy(Actor) - Method in class net.serenitybdd.screenplay.rest.questions.TheResponseStatusCode
 
as(Actor) - Static method in class net.serenitybdd.screenplay.rest.abilities.CallAnApi
Used to access the Actor's ability to CallAnApi from within the Interaction classes, such as GET or PUT
at(String) - Static method in class net.serenitybdd.screenplay.rest.abilities.CallAnApi
Ability to Call and api at a specified baseUrl

C

CallAnApi - Class in net.serenitybdd.screenplay.rest.abilities
A Screenplay ability that allows an actor to perform REST queries against a specified API.

D

Delete - Class in net.serenitybdd.screenplay.rest.interactions
Put something to a REST resource.
Delete(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Delete
 

E

Ensure - Class in net.serenitybdd.screenplay.rest.interactions
 
Ensure(String, Consumer<ValidatableResponse>) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Ensure
 
evaluateFor(Actor) - Method in class net.serenitybdd.screenplay.rest.questions.ResponseConsequence
 

F

from(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Delete
 

G

Get - Class in net.serenitybdd.screenplay.rest.interactions
Perform a GET query on a given REST resource
Get(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Get
 
getLastResponse() - Method in class net.serenitybdd.screenplay.rest.abilities.CallAnApi
 

H

Head - Class in net.serenitybdd.screenplay.rest.interactions
Path something to a REST resource.
Head(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Head
 

I

isSilent() - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 

L

LastResponse - Class in net.serenitybdd.screenplay.rest.questions
 
LastResponse() - Constructor for class net.serenitybdd.screenplay.rest.questions.LastResponse
 

N

net.serenitybdd.screenplay.rest.abilities - package net.serenitybdd.screenplay.rest.abilities
 
net.serenitybdd.screenplay.rest.interactions - package net.serenitybdd.screenplay.rest.interactions
 
net.serenitybdd.screenplay.rest.questions - package net.serenitybdd.screenplay.rest.questions
 

O

Options - Class in net.serenitybdd.screenplay.rest.interactions
Path something to a REST resource.
Options(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Options
 

P

Patch - Class in net.serenitybdd.screenplay.rest.interactions
An OPTIONS query This is a simple interaction class suitable for simple queries.
Patch(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Patch
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Delete
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Ensure
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Get
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Head
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Options
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Patch
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Post
 
performAs(T) - Method in class net.serenitybdd.screenplay.rest.interactions.Put
 
Post - Class in net.serenitybdd.screenplay.rest.interactions
Post something to a REST resource.
Post(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Post
 
Put - Class in net.serenitybdd.screenplay.rest.interactions
Put something to a REST resource.
Put(String) - Constructor for class net.serenitybdd.screenplay.rest.interactions.Put
 

R

received() - Static method in class net.serenitybdd.screenplay.rest.questions.LastResponse
 
resolve(String) - Method in class net.serenitybdd.screenplay.rest.abilities.CallAnApi
 
resource(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Get
 
ResponseConsequence - Class in net.serenitybdd.screenplay.rest.questions
 
RestInteraction - Class in net.serenitybdd.screenplay.rest.interactions
A base class for all Screenplay REST interactions, which gives direct access to the RestAssured API.
RestInteraction() - Constructor for class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
RestQueryFunction - Interface in net.serenitybdd.screenplay.rest.questions
 
RestQuestion<T> - Class in net.serenitybdd.screenplay.rest.questions
A REST query that sends a GET request to an endpoint and returns a result of a given type.
RestQuestion(String, String, List<RestQueryFunction>, Function<Response, T>) - Constructor for class net.serenitybdd.screenplay.rest.questions.RestQuestion
 
RestQuestionBuilder<T> - Class in net.serenitybdd.screenplay.rest.questions
 
RestQuestionBuilder() - Constructor for class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
RestResponseFunction<T> - Interface in net.serenitybdd.screenplay.rest.questions
 
returning(RestResponseFunction<T>) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
Returning<T> - Interface in net.serenitybdd.screenplay.rest.questions
 
returning(RestResponseFunction<T>) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 

S

seeThatResponse(String, Consumer<ValidatableResponse>) - Static method in class net.serenitybdd.screenplay.rest.questions.ResponseConsequence
 
seeThatResponse(Consumer<ValidatableResponse>) - Static method in class net.serenitybdd.screenplay.rest.questions.ResponseConsequence
 
statusCode() - Static method in class net.serenitybdd.screenplay.rest.questions.TheResponse
 

T

that(String, Consumer<ValidatableResponse>) - Static method in class net.serenitybdd.screenplay.rest.interactions.Ensure
 
TheResponse - Class in net.serenitybdd.screenplay.rest.questions
 
TheResponse() - Constructor for class net.serenitybdd.screenplay.rest.questions.TheResponse
 
TheResponseStatusCode - Class in net.serenitybdd.screenplay.rest.questions
 
TheResponseStatusCode() - Constructor for class net.serenitybdd.screenplay.rest.questions.TheResponseStatusCode
 
to(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Head
 
to(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Options
 
to(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Patch
 
to(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Post
 
to(String) - Static method in class net.serenitybdd.screenplay.rest.interactions.Put
 
to(String) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
To<T> - Interface in net.serenitybdd.screenplay.rest.questions
 
to(String) - Method in interface net.serenitybdd.screenplay.rest.questions.To
 
toString() - Method in class net.serenitybdd.screenplay.rest.abilities.CallAnApi
 
toString() - Method in class net.serenitybdd.screenplay.rest.questions.ResponseConsequence
 
toString() - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestion
 

U

UnexpectedRestResponseException - Exception in net.serenitybdd.screenplay.rest.questions
Thrown when a REEST Question receives a response with a status that is not 2xx.
UnexpectedRestResponseException(String) - Constructor for exception net.serenitybdd.screenplay.rest.questions.UnexpectedRestResponseException
 

W

with(RestQueryFunction) - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
with(List<RestQueryFunction>) - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
with(RestQueryFunction) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
with(RestQueryFunction) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 
withNoReporting() - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
withPathParameters(String, Object) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
withPathParameters(String, Object, Object...) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
withPathParameters(String, Object) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 
withPathParameters(String, Object, Object...) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 
withQueryParameters(String, Object) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
withQueryParameters(String, Object, Object...) - Method in class net.serenitybdd.screenplay.rest.questions.RestQuestionBuilder
 
withQueryParameters(String, Object) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 
withQueryParameters(String, Object, Object...) - Method in interface net.serenitybdd.screenplay.rest.questions.Returning
 
withRequest(RestQueryFunction) - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
withRequest(List<RestQueryFunction>) - Method in class net.serenitybdd.screenplay.rest.interactions.RestInteraction
 
A C D E F G H I L N O P R S T U W 
Skip navigation links