Package graphql.execution.instrumentation.parameters

Class InstrumentationExecutionParameters

java.lang.Object

graphql.execution.instrumentation.parameters.InstrumentationExecutionParameters

Direct Known Subclasses:

InstrumentationValidationParameters

@PublicApi
public class InstrumentationExecutionParameters
extends Object

Parameters sent to Instrumentation methods

Field Summary

Fields

Modifier and Type	Field	Description
private final Object	context
private final ExecutionInput	executionInput
private final GraphQLContext	graphQLContext
private final InstrumentationState	instrumentationState
private final String	operation
private final String	query
private final GraphQLSchema	schema
private final Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
InstrumentationExecutionParameters(ExecutionInput executionInput, GraphQLSchema schema, InstrumentationState instrumentationState)

Method Summary

Modifier and Type	Method	Description
<T> T	getContext()	Deprecated. use getGraphQLContext() instead
ExecutionInput	getExecutionInput()
GraphQLContext	getGraphQLContext()
<T extends InstrumentationState> T	getInstrumentationState()	Deprecated. state is now passed in direct to instrumentation methods
String	getOperation()
String	getQuery()
GraphQLSchema	getSchema()
Map<String,Object>	getVariables()
InstrumentationExecutionParameters	withNewState(InstrumentationState instrumentationState)	Deprecated. state is now passed in direct to instrumentation methods

Methods inherited from class java.lang.Object

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

Field Details

executionInput

private final ExecutionInput executionInput

query

private final String query

operation

private final String operation

context

private final Object context

graphQLContext

private final GraphQLContext graphQLContext

variables

private final Map<String,Object> variables

instrumentationState

private final InstrumentationState instrumentationState

schema

private final GraphQLSchema schema

Constructor Details

InstrumentationExecutionParameters

public InstrumentationExecutionParameters(ExecutionInput executionInput,
 GraphQLSchema schema,
 InstrumentationState instrumentationState)

Method Details

withNewState

@Deprecated
public InstrumentationExecutionParameters withNewState(InstrumentationState instrumentationState)

Deprecated.

state is now passed in direct to instrumentation methods

Returns a cloned parameters object with the new state

Parameters:

instrumentationState - the new state for this parameters object

Returns:

a new parameters object with the new state

getExecutionInput

public ExecutionInput getExecutionInput()

getQuery

public String getQuery()

getOperation

public String getOperation()

getContext

@Deprecated
public <T> T getContext()

Deprecated.

use getGraphQLContext() instead

Type Parameters:

T - for two

Returns:

the legacy context

getGraphQLContext

public GraphQLContext getGraphQLContext()

getVariables

public Map<String,Object> getVariables()

getInstrumentationState

@Deprecated
public <T extends InstrumentationState> T getInstrumentationState()

Deprecated.

state is now passed in direct to instrumentation methods

Previously the instrumentation parameters had access to the state created via Instrumentation.createState(InstrumentationCreateStateParameters) but now to save object allocations, the state is passed directly into instrumentation methods

Type Parameters:

T - for two

Returns:

the state created previously during a call to Instrumentation.createState(InstrumentationCreateStateParameters)

getSchema

public GraphQLSchema getSchema()