org.springframework.graphql.execution

Interface GraphQlSource.Builder

Enclosing interface:

GraphQlSource

public static interface GraphQlSource.Builder

Builder for a GraphQlSource.

Method Summary

Modifier and Type	Method and Description
GraphQlSource	build() Build the GraphQlSource.
GraphQlSource.Builder	configureGraphQl(Consumer<GraphQL.Builder> configurer) Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.
GraphQlSource.Builder	configureRuntimeWiring(RuntimeWiringConfigurer configurer) Add a component that is given access to the RuntimeWiring.Builder used to register DataFetchers, custom scalar types, type resolvers, and more.
GraphQlSource.Builder	exceptionResolvers(List<DataFetcherExceptionResolver> resolvers) Add DataFetcherExceptionResolver's to use for resolving exceptions from DataFetcher's.
GraphQlSource.Builder	instrumentation(List<Instrumentation> instrumentations) Provide Instrumentation components to instrument the execution of GraphQL queries.
GraphQlSource.Builder	schemaResources(Resource... resources) Add ".graphqls" schema resources to be merged into the type registry.
GraphQlSource.Builder	typeVisitors(List<GraphQLTypeVisitor> typeVisitors) Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema.

Method Detail

schemaResources

GraphQlSource.Builder schemaResources(Resource... resources)

Add ".graphqls" schema resources to be merged into the type registry.

Parameters:

resources - resources for the GraphQL schema

Returns:

the current builder

See Also:

SchemaParser.parse(File)

configureRuntimeWiring

GraphQlSource.Builder configureRuntimeWiring(RuntimeWiringConfigurer configurer)

Add a component that is given access to the RuntimeWiring.Builder used to register DataFetchers, custom scalar types, type resolvers, and more.

Parameters:

configurer - the configurer to apply

Returns:

the current builder

See Also:

SchemaGenerator.makeExecutableSchema(TypeDefinitionRegistry, RuntimeWiring)

exceptionResolvers

GraphQlSource.Builder exceptionResolvers(List<DataFetcherExceptionResolver> resolvers)

Add DataFetcherExceptionResolver's to use for resolving exceptions from DataFetcher's.

Parameters:

resolvers - the resolvers to add

Returns:

the current builder

typeVisitors

GraphQlSource.Builder typeVisitors(List<GraphQLTypeVisitor> typeVisitors)

Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema.

Note: Visitors are applied via SchemaTraverser and cannot change the schema.

Parameters:

typeVisitors - the type visitors

Returns:

the current builder

See Also:

SchemaTransformer.transformSchema(GraphQLSchema, GraphQLTypeVisitor)

instrumentation

GraphQlSource.Builder instrumentation(List<Instrumentation> instrumentations)

Provide Instrumentation components to instrument the execution of GraphQL queries.

Parameters:

instrumentations - the instrumentation components

Returns:

the current builder

See Also:

GraphQL.Builder.instrumentation(Instrumentation)

configureGraphQl

GraphQlSource.Builder configureGraphQl(Consumer<GraphQL.Builder> configurer)

Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.

Parameters:

configurer - the configurer

Returns:

the current builder

build

GraphQlSource build()

Build the GraphQlSource.

Returns:

the built GraphQlSource