Package org.springframework.graphql.client

Class DgsGraphQlClient

java.lang.Object

org.springframework.graphql.client.DgsGraphQlClient

public final class DgsGraphQlClient
extends Object

Simple wrapper around a GraphQlClient that prepares the request from classes generated with the DGS Code Generation library.

 GraphQlClient client = ... ;
 DgsGraphQlClient dgsClient = DgsGraphQlClient.create(client);

 List<Book> books = dgsClient.request(new BooksGraphQLQuery())
                .projection(new BooksProjectionRoot<>().id().name())
                .retrieveSync()
                .toEntityList(Book.class);
 

Since:

1.3.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	DgsGraphQlClient.RequestSpec	Declare options to gather input for a GraphQL request and execute it.

Method Summary

Modifier and Type	Method	Description
static DgsGraphQlClient	create(GraphQlClient client)	Create instance that wraps the given GraphQlClient.
GraphQlClient	getGraphQlClient()	Return the wrapped GraphQlClient to delegate to.
DgsGraphQlClient.RequestSpec	request(com.netflix.graphql.dgs.client.codegen.GraphQLQuery query)	Start defining a GraphQL request for the given GraphQLQuery.

Methods inherited from class java.lang.Object

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

Method Details

getGraphQlClient

public GraphQlClient getGraphQlClient()

Return the wrapped GraphQlClient to delegate to.

request

public DgsGraphQlClient.RequestSpec request(com.netflix.graphql.dgs.client.codegen.GraphQLQuery query)

Start defining a GraphQL request for the given GraphQLQuery.

Parameters:

query - the GraphQL query

create

public static DgsGraphQlClient create(GraphQlClient client)

Create instance that wraps the given GraphQlClient.

Parameters:

client - the client to delegate to