graphql

Class ExecutionInput

java.lang.Object

graphql.ExecutionInput

@PublicApi
public class ExecutionInput
extends java.lang.Object

This represents the series of values that can be input on a graphql query execution

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutionInput.Builder

Method Summary

Modifier and Type	Method and Description
CacheControl	getCacheControl()
java.lang.Object	getContext()
org.dataloader.DataLoaderRegistry	getDataLoaderRegistry()
ExecutionId	getExecutionId()
java.util.Locale	getLocale() This returns the locale of this operation.
java.lang.String	getOperationName()
java.lang.String	getQuery()
java.lang.Object	getRoot()
java.util.Map<java.lang.String,java.lang.Object>	getVariables()
static ExecutionInput.Builder	newExecutionInput()
static ExecutionInput.Builder	newExecutionInput(java.lang.String query) Creates a new builder of ExecutionInput objects with the given query
java.lang.String	toString()
ExecutionInput	transform(java.util.function.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getQuery

public java.lang.String getQuery()

Returns:

the query text

getOperationName

public java.lang.String getOperationName()

Returns:

the name of the query operation

getContext

public java.lang.Object getContext()

Returns:

the context object to pass to all data fetchers

getRoot

public java.lang.Object getRoot()

Returns:

the root object to start the query execution on

getVariables

public java.util.Map<java.lang.String,java.lang.Object> getVariables()

Returns:

a map of 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

getCacheControl

public CacheControl getCacheControl()

Returns:

the cache control helper associated with this execution

getExecutionId

public ExecutionId getExecutionId()

Returns:

Id that will be/was used to execute this operation.

getLocale

public java.util.Locale getLocale()

This returns the locale of this operation.

Returns:

the locale of this operation

transform

public ExecutionInput transform(java.util.function.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

newExecutionInput

public static ExecutionInput.Builder newExecutionInput()

Returns:

a new builder of ExecutionInput objects

newExecutionInput

public static ExecutionInput.Builder newExecutionInput(java.lang.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