Package graphql
Class ExecutionInput
java.lang.Object
graphql.ExecutionInput
This represents the series of values that can be input on a graphql query execution
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Object
private final org.dataloader.DataLoaderRegistry
private final ExecutionId
private final GraphQLContext
private final Object
private final Locale
private final String
private final String
private final RawVariables
private final Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.org.dataloader.DataLoaderRegistry
This returns the locale of this operation.getQuery()
getRoot()
static ExecutionInput.Builder
static ExecutionInput.Builder
newExecutionInput
(String query) Creates a new builder of ExecutionInput objects with the given querytoString()
transform
(Consumer<ExecutionInput.Builder> builderConsumer) This helps you transform the current ExecutionInput object into another one by starting a builder with all the current values and allows you to transform it how you want.
-
Field Details
-
query
-
operationName
-
context
-
graphQLContext
-
localContext
-
root
-
rawVariables
-
extensions
-
dataLoaderRegistry
private final org.dataloader.DataLoaderRegistry dataLoaderRegistry -
executionId
-
locale
-
-
Constructor Details
-
ExecutionInput
-
-
Method Details
-
getQuery
- Returns:
- the query text
-
getOperationName
- Returns:
- the name of the query operation
-
getContext
Deprecated.- usegetGraphQLContext()
The legacy context object has been deprecated in favour of the more shareablegetGraphQLContext()
- Returns:
- the context object to pass to all data fetchers
-
getGraphQLContext
- Returns:
- the shared
GraphQLContext
object to pass to all data fetchers
-
getLocalContext
- Returns:
- the local context object to pass to all top level (i.e. query, mutation, subscription) data fetchers
-
getRoot
- Returns:
- the root object to start the query execution on
-
getVariables
- Returns:
- a map of raw variables that can be referenced via $syntax in the query.
-
getRawVariables
- Returns:
- a map of raw variables that can be referenced via $syntax in the query.
-
getDataLoaderRegistry
public org.dataloader.DataLoaderRegistry getDataLoaderRegistry()- Returns:
- the data loader registry associated with this execution
-
getExecutionId
- Returns:
- Id that will be/was used to execute this operation.
-
getLocale
This returns the locale of this operation.- Returns:
- the locale of this operation
-
getExtensions
- Returns:
- a map of extension values that can be sent in to a request
-
transform
This helps you transform the current ExecutionInput object into another one by starting a builder with all the current values and allows you to transform it how you want.- Parameters:
builderConsumer
- the consumer code that will be given a builder to transform- Returns:
- a new ExecutionInput object based on calling build on that builder
-
toString
-
newExecutionInput
- Returns:
- a new builder of ExecutionInput objects
-
newExecutionInput
Creates a new builder of ExecutionInput objects with the given query- Parameters:
query
- the query to execute- Returns:
- a new builder of ExecutionInput objects
-
getGraphQLContext()