Package org.springframework.graphql.client

Interface GraphQlClient.Builder<B extends GraphQlClient.Builder<B>>

Type Parameters:

B - the client builder type

All Known Subinterfaces:

HttpGraphQlClient.Builder<B>, RSocketGraphQlClient.Builder<B>, WebGraphQlClient.Builder<B>, WebSocketGraphQlClient.Builder<B>

All Known Implementing Classes:

AbstractGraphQlClientBuilder

Enclosing interface:

GraphQlClient

public static interface GraphQlClient.Builder<B extends GraphQlClient.Builder<B>>

Defines a builder for creating GraphQlClient instances.

Method Summary

Modifier and Type	Method	Description
GraphQlClient	build()	Build the GraphQlClient instance.
B	documentSource(DocumentSource contentLoader)	Configure a DocumentSource for use with GraphQlClient.documentName(String) for resolving a document by name.
B	interceptor(GraphQlClientInterceptor... interceptors)	Configure interceptors to be invoked before delegating to the GraphQlTransport to perform the request.
B	interceptors(Consumer<List<GraphQlClientInterceptor>> interceptorsConsumer)	Customize the list of interceptors.

Method Details

interceptor

B interceptor(GraphQlClientInterceptor... interceptors)

Configure interceptors to be invoked before delegating to the GraphQlTransport to perform the request.

Parameters:

interceptors - the interceptors to add

Returns:

this builder

interceptors

B interceptors(Consumer<List<GraphQlClientInterceptor>> interceptorsConsumer)

Customize the list of interceptors. The provided list is "live", so the consumer can inspect and insert interceptors accordingly.

Parameters:

interceptorsConsumer - consumer to customize the interceptors with

Returns:

this builder

documentSource

B documentSource(DocumentSource contentLoader)

Configure a DocumentSource for use with GraphQlClient.documentName(String) for resolving a document by name.

By default, this is set to ResourceDocumentSource with classpath location "graphql-documents/" and ResourceDocumentSource.FILE_EXTENSIONS as extensions.

Parameters:

contentLoader - the document source

build

GraphQlClient build()

Build the GraphQlClient instance.