Package graphql

Class ExecutionInput

java.lang.Object
graphql.ExecutionInput
@PublicApi public class ExecutionInput extends Object
This represents the series of values that can be input on a graphql query execution

  • Field Details

    • query

      private final String query

    • operationName

      private final String operationName

    • context

      private final Object context

    • graphQLContext

      private final GraphQLContext graphQLContext

    • localContext

      private final Object localContext

    • root

      private final Object root

    • rawVariables

      private final RawVariables rawVariables

    • extensions

      private final Map<String,Object> extensions

    • dataLoaderRegistry

      private final org.dataloader.DataLoaderRegistry dataLoaderRegistry

    • executionId

      private final ExecutionId executionId

    • locale

      private final Locale locale

  • Constructor Details

  • Method Details

    • getQuery

      public String getQuery()
      Returns:
      the query text

    • getOperationName

      public String getOperationName()
      Returns:
      the name of the query operation

    • getContext

      @Deprecated public Object getContext()
      Deprecated.
      - use getGraphQLContext()
      The legacy context object has been deprecated in favour of the more shareable getGraphQLContext()
      Returns:
      the context object to pass to all data fetchers

    • getGraphQLContext

      public GraphQLContext getGraphQLContext()
      Returns:
      the shared GraphQLContext object to pass to all data fetchers

    • getLocalContext

      public Object getLocalContext()
      Returns:
      the local context object to pass to all top level (i.e. query, mutation, subscription) data fetchers

    • getRoot

      public Object getRoot()
      Returns:
      the root object to start the query execution on

    • getVariables

      public Map<String,Object> getVariables()
      Returns:
      a map of raw variables that can be referenced via $syntax in the query.

    • getRawVariables

      public RawVariables 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

      public ExecutionId getExecutionId()
      Returns:
      Id that will be/was used to execute this operation.

    • getLocale

      public Locale getLocale()
      This returns the locale of this operation.
      Returns:
      the locale of this operation

    • getExtensions

      public Map<String,Object> getExtensions()
      Returns:
      a map of extension values that can be sent in to a request

    • transform

      public ExecutionInput 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.
      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

      public String toString()
      Overrides:
      toString in class Object

    • newExecutionInput

      public static ExecutionInput.Builder newExecutionInput()
      Returns:
      a new builder of ExecutionInput objects

    • newExecutionInput

      public static ExecutionInput.Builder newExecutionInput(String query)
      Creates a new builder of ExecutionInput objects with the given query
      Parameters:
      query - the query to execute
      Returns:
      a new builder of ExecutionInput objects