Class IncrementalPayload

java.lang.Object

graphql.incremental.IncrementalPayload

Direct Known Subclasses:

DeferPayload, StreamPayload

@ExperimentalApi
public abstract class IncrementalPayload
extends Object

Represents a payload that can be resolved after the initial response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IncrementalPayload.Builder<T extends IncrementalPayload.Builder<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IncrementalPayload(List<Object> path, String label, List<GraphQLError> errors, Map<Object,Object> extensions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Object	errorsToSpec(List<GraphQLError> errors)
@Nullable List<GraphQLError>	getErrors()
@Nullable Map<Object,Object>	getExtensions()
@Nullable String	getLabel()
List<Object>	getPath()
int	hashCode()
Map<String,Object>	toSpecification()

Methods inherited from class Object

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

Constructor Details

IncrementalPayload

protected IncrementalPayload(List<Object> path,
 String label,
 List<GraphQLError> errors,
 Map<Object,Object> extensions)

Method Details

getPath

public List<Object> getPath()

Returns:

list of field names and indices from root to the location of the corresponding `@defer` or `@stream` directive.

getLabel

public @Nullable String getLabel()

Returns:

value derived from the corresponding `@defer` or `@stream` directive.

getErrors

public @Nullable List<GraphQLError> getErrors()

Returns:

a list of field errors encountered during execution.

getExtensions

public @Nullable Map<Object,Object> getExtensions()

Returns:

a map of extensions or null if there are none

toSpecification

public Map<String,Object> toSpecification()

errorsToSpec

protected Object errorsToSpec(List<GraphQLError> errors)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object