org.springframework.graphql.web

Class WebOutput.Builder

java.lang.Object

org.springframework.graphql.web.WebOutput.Builder

Enclosing class:

WebOutput

public static final class WebOutput.Builder
extends Object

Builder to transform a WebOutput.

Method Summary

Modifier and Type	Method and Description
WebOutput	build()
WebOutput.Builder	data(Object data) Set the data of the GraphQL execution result.
WebOutput.Builder	errors(List<GraphQLError> errors) Set the errors of the GraphQL execution result.
WebOutput.Builder	extensions(Map<Object,Object> extensions) Set the extensions of the GraphQL execution result.
WebOutput.Builder	responseHeader(String name, String... values) Add a custom header to be set on the HTTP response.
WebOutput.Builder	responseHeaders(Consumer<HttpHeaders> consumer) Consume and update the headers to be set on the HTTP response.

Methods inherited from class java.lang.Object

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

Method Detail

data

public WebOutput.Builder data(@Nullable
                              Object data)

Set the data of the GraphQL execution result.

Parameters:

data - the execution result data

Returns:

the current builder

errors

public WebOutput.Builder errors(@Nullable
                                List<GraphQLError> errors)

Set the errors of the GraphQL execution result.

Parameters:

errors - the execution result errors

Returns:

the current builder

extensions

public WebOutput.Builder extensions(@Nullable
                                    Map<Object,Object> extensions)

Set the extensions of the GraphQL execution result.

Parameters:

extensions - the execution result extensions

Returns:

the current builder

responseHeader

public WebOutput.Builder responseHeader(String name,
                                        String... values)

Add a custom header to be set on the HTTP response.

Note: This can be used for GraphQL over HTTP requests but has no impact for queries over a WebSocket session where the initial handshake request completes before queries begin.

Parameters:

name - the HTTP header name

values - the HTTP header values

Returns:

the current builder

responseHeaders

public WebOutput.Builder responseHeaders(Consumer<HttpHeaders> consumer)

Consume and update the headers to be set on the HTTP response.

Note: This can be used for GraphQL over HTTP requests but has no impact for queries over a WebSocket session where the initial handshake request completes before queries begin.

Parameters:

consumer - callback that updates the HTTP headers

Returns:

the current builder

build

public WebOutput build()