Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
E
- encode(String) - Method in interface org.springframework.graphql.data.pagination.CursorEncoder
-
Encode the given cursor value for external use.
- encode(Map<String, Object>) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
-
Encode the result map.
- encoder(Encoder<?>) - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder
-
Configure the JSON encoder to use for mapping response data to higher level objects.
- encodeResponseIfNecessary(WebGraphQlResponse) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
-
Encode the GraphQL response if custom codecs were provided, or return the result map.
- EncodingCursorStrategy<T> - Class in org.springframework.graphql.data.pagination
-
Decorator for a
CursorStrategy
that applies aCursorEncoder
to the cursor String to make it opaque for external use. - entity(Class<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to the target type.
- entity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to the target type.
- entityList(Class<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to a List of the target type.
- entityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to a List of the target type.
- EntityMapping - Annotation Interface in org.springframework.graphql.data.federation
-
Annotation for mapping a handler method to a federated schema type.
- EntityMappingInfo(String, HandlerMethod) - Constructor for record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
-
Creates an instance of a
EntityMappingInfo
record class. - equals(Object) - Method in class org.springframework.graphql.data.ArgumentValue
- equals(Object) - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
- equals(Object) - Method in class org.springframework.graphql.data.method.HandlerMethod
- equals(Object) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
- equals(Object) - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
- error(String, List<GraphQLError>) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
-
Create an
"error"
server message. - ERROR - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
-
Operation execution error(s) in response to the
GraphQlWebSocketMessageType.SUBSCRIBE
message. - ERROR_TYPE - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
-
Class name of the data fetching error.
- errorFilter(Predicate<ResponseError>) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
- errorFilter(Predicate<ResponseError>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Builder
-
Configure a global
filter
that applies to all requests. - errors() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Response
-
Return a spec to filter out or inspect errors.
- errors(List<GraphQLError>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
-
Set the
errors
of the GraphQL execution result. - errorType(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
- ErrorType - Enum Class in org.springframework.graphql.execution
-
Common categories to use to classify for exceptions raised by
DataFetcher
's that can enable a client to make automated decisions. - exceptionResolvers(List<DataFetcherExceptionResolver>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
- exceptionResolvers(List<DataFetcherExceptionResolver>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
-
Add
DataFetcherExceptionResolver
's that are invoked when aDataFetcher
raises an exception. - execute() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
-
Create
GraphQLQueryRequest
, serialize it to a String document to send, and delegate to the wrappedGraphQlClient
. - execute() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
-
Execute request with a single response, e.g.
- execute() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request and return a spec for further inspection of response data and errors.
- execute(ExecutionGraphQlRequest) - Method in class org.springframework.graphql.execution.DefaultExecutionGraphQlService
- execute(ExecutionGraphQlRequest) - Method in interface org.springframework.graphql.ExecutionGraphQlService
-
Execute the request and return the response.
- execute(GraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlTransport
-
Execute a request with a single response such as a "query" or "mutation".
- execute(GraphQlRequest) - Method in interface org.springframework.graphql.client.SyncGraphQlTransport
-
Execute a request with a single response such as a "query" or "mutation".
- executeAndVerify() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request and verify the response contains no errors.
- executeSubscription() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
-
Create
GraphQLQueryRequest
, serialize it to a String document to send, and delegate to the wrappedGraphQlClient
. - executeSubscription() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
-
Execute a "subscription" request and return a stream of responses.
- executeSubscription() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request as a subscription and return a spec with options to transform the result stream.
- executeSubscription(GraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlTransport
-
Execute a "subscription" request with a stream of responses.
- executeSync() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
-
Create
GraphQLQueryRequest
, serialize it to a String document to send, and delegate to the wrappedGraphQlClient
. - executeSync() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
-
Execute request with a single response, e.g.
- EXECUTION_ID - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames
-
ExecutionId
of the GraphQL request. - EXECUTION_REQUEST - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
-
Observation created for GraphQL execution requests.
- ExecutionGraphQlRequest - Interface in org.springframework.graphql
-
Implementation of
GraphQlRequest
for request handling through GraphQL Java with support for customizing theExecutionInput
passed intoGraphQL
. - ExecutionGraphQlResponse - Interface in org.springframework.graphql
-
Implementation of
GraphQlResponse
that wraps theExecutionResult
returned fromGraphQL
to expose it asGraphQlResponse
, also providing access to theExecutionInput
used for the request. - ExecutionGraphQlService - Interface in org.springframework.graphql
-
Strategy to execute a GraphQL request by invoking GraphQL Java.
- ExecutionGraphQlServiceTester - Interface in org.springframework.graphql.test.tester
-
GraphQlTester
that executes requests through anExecutionGraphQlService
on the server side, without a client. - ExecutionGraphQlServiceTester.Builder<B extends ExecutionGraphQlServiceTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Default
ExecutionGraphQlServiceTester.Builder
implementation. - executionId(ExecutionId) - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
-
Configure the
ExecutionId
to set onExecutionInput.getExecutionId()
, overriding the transport assignedid
. - executionId(ExecutionId) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
- executionId(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
- ExecutionRequestObservationContext - Class in org.springframework.graphql.observation
-
Context that holds information for metadata collection during observations for
GraphQL requests
. - ExecutionRequestObservationContext(ExecutionInput) - Constructor for class org.springframework.graphql.observation.ExecutionRequestObservationContext
- ExecutionRequestObservationConvention - Interface in org.springframework.graphql.observation
-
Interface for an
ObservationConvention
forGraphQL requests
. - expect(Predicate<ResponseError>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors
-
Use this to declare errors that are expected.
- extension(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
-
Add a value for a protocol extension.
- extension(String, Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Add a value for a protocol extension.
- extensions(Map<Object, Object>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
-
Set the
extensions
of the GraphQL execution result. - extensions(Map<String, Object>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
-
Add all given protocol extensions.
- EXTENSIONS_KEY - Static variable in class org.springframework.graphql.support.DefaultGraphQlRequest
- extract(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy
- extract(DataFetchingEnvironment) - Method in interface org.springframework.graphql.data.query.SortStrategy
-
Return a
Sort
instance by extracting the sort information from GraphQL arguments, orSort.unsorted()
otherwise. - extractValues(ArgumentValue<?>, ValueExtractor.ValueReceiver) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentValueValueExtractor
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form