Package graphql.incremental

Interface DelayedIncrementalPartialResult

All Known Implementing Classes:
DelayedIncrementalPartialResultImpl
@ExperimentalApi public interface DelayedIncrementalPartialResult
Represents a result that is delivered asynchronously, after the initial IncrementalExecutionResult.

Multiple defer and/or stream payloads (represented by IncrementalPayload) can be part of the same DelayedIncrementalPartialResult

  • Method Details

    • getIncremental

      @Nullable List<IncrementalPayload> getIncremental()
      Returns:
      a list of defer and/or stream payloads.

    • hasNext

      boolean hasNext()
      Indicates whether the stream will continue emitting DelayedIncrementalPartialResults after this one.

      The value returned by this method should be "true" for all but the last response in the stream. The value of this entry is `false` for the last response of the stream.

      Returns:
      "true" if there are more responses in the stream, "false" otherwise.

    • getExtensions

      @Nullable Map<Object,Object> getExtensions()
      Returns:
      a map of extensions or null if there are none

    • toSpecification

      Map<String,Object> toSpecification()
      Returns:
      a map of the result that strictly follows the spec