Package com.graphql_java_generator.client.request

Class Builder

java.lang.Object

com.graphql_java_generator.client.request.Builder

public class Builder
extends Object

This builder is provided for compatibility of existing code, that would have been developed before the 1.6 release. It allows to create ObjectResponse, that will define the content of the GraphQL request toward the server.

Author:

etienne-sf

Constructor Summary

Constructors

Constructor	Description
Builder(org.springframework.graphql.client.GraphQlClient graphQlClient, Class<? extends AbstractGraphQLRequest> graphQLRequestClass)	This Builder allows to build a Full request, that is request as you can execute in the graphiql interface.
Builder(org.springframework.graphql.client.GraphQlClient graphQlClient, Class<? extends AbstractGraphQLRequest> graphQLRequestClass, String fieldName, RequestType requestType, InputParameter... inputParams)	This Builder allows to build a Partial request, that is a request for only one query/mutation/subscription.

Method Summary

Modifier and Type	Method	Description
ObjectResponse	build()	Returns the built ObjectResponse.
Builder	withQueryResponseDef(String queryResponseDef)	Builds a ObjectResponse from a part of a GraphQL query.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(org.springframework.graphql.client.GraphQlClient graphQlClient,
 Class<? extends AbstractGraphQLRequest> graphQLRequestClass)

This Builder allows to build a Full request, that is request as you can execute in the graphiql interface.
When calling the withQueryResponseDef(String), a new AbstractGraphQLRequest is created by calling its AbstractGraphQLRequest#AbstractGraphQLRequest(String) constructor.

Parameters:

graphQLRequestClass - The graphQLRequestClass inherits from AbstractGraphQLRequest, and contains the generated context that allows proper GraphQL request executions

Builder

public Builder(org.springframework.graphql.client.GraphQlClient graphQlClient,
 Class<? extends AbstractGraphQLRequest> graphQLRequestClass,
 String fieldName,
 RequestType requestType,
 InputParameter... inputParams)

This Builder allows to build a Partial request, that is a request for only one query/mutation/subscription.
When calling the withQueryResponseDef(String), the query request can be something like the one below, based on the hero query of the star wars schema:

 {id appearsIn friends {name friends {friends{id name appearsIn}}}}
 

This defines only the part of the GraphQL request that defines the expected response content from the GraphQL server.

Parameters:

graphQLRequestClass - The graphQLRequestClass inherits from AbstractGraphQLRequest, and contains the generated context that allows proper GraphQL request executions

fieldName - The query/mutation/subscription name, as defined in the GraphQL schema

requestType - The request type allows to search fieldName in the query or in the mutation or the subscription

inputParams - The input parameters for this query/mutation/subscription

Method Details

withQueryResponseDef

public Builder withQueryResponseDef(String queryResponseDef)
                             throws GraphQLRequestPreparationException

Builds a ObjectResponse from a part of a GraphQL query. This part define what's expected as a response for the field of the current ObjectResponse for this builder.

Parameters:

queryResponseDef - A part of a response, for instance (for the hero query of the Star Wars GraphQL schema): "{ id name friends{name}}"
No special character are allowed (linefeed...).
This parameter can be a null or an empty string. In this case, all scalar fields are added.

episode -

Returns:

Throws:

GraphQLRequestPreparationException

build

public ObjectResponse build()
                     throws GraphQLRequestPreparationException

Returns the built ObjectResponse. If no field (either scalar or suboject) has been added, then all scalar fields are added.

Returns:

Throws:

GraphQLRequestPreparationException