Package graphql.incremental

Class IncrementalPayload

java.lang.Object

graphql.incremental.IncrementalPayload

Direct Known Subclasses:

DeferPayload, StreamPayload

@ExperimentalApi
public abstract class IncrementalPayload
extends java.lang.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(java.util.List<java.lang.Object> path, java.lang.String label, java.util.List<GraphQLError> errors, java.util.Map<java.lang.Object,java.lang.Object> extensions)

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	errorsToSpec(java.util.List<GraphQLError> errors)
java.util.List<GraphQLError>	getErrors()
java.util.Map<java.lang.Object,java.lang.Object>	getExtensions()
java.lang.String	getLabel()
java.util.List<java.lang.Object>	getPath()
protected java.util.Map<java.lang.String,java.lang.Object>	toSpecification()

Methods inherited from class java.lang.Object

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

Constructor Detail

IncrementalPayload

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

Method Detail

getPath

public java.util.List<java.lang.Object> getPath()

Returns:

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

getLabel

@Nullable
public java.lang.String getLabel()

Returns:

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

getErrors

@Nullable
public java.util.List<GraphQLError> getErrors()

Returns:

a list of field errors encountered during execution.

getExtensions

@Nullable
public java.util.Map<java.lang.Object,java.lang.Object> getExtensions()

Returns:

a map of extensions or null if there are none

toSpecification

protected java.util.Map<java.lang.String,java.lang.Object> toSpecification()

errorsToSpec

protected java.lang.Object errorsToSpec(java.util.List<GraphQLError> errors)