Package org.springframework.graphql.client

Class DgsGraphQlClient.RequestSpec

java.lang.Object

org.springframework.graphql.client.DgsGraphQlClient.RequestSpec

Enclosing class:

DgsGraphQlClient

public final class DgsGraphQlClient.RequestSpec
extends Object

Declare options to gather input for a GraphQL request and execute it.

Method Summary

Modifier and Type	Method	Description
DgsGraphQlClient.RequestSpec	attribute(String name, Object value)	Set a client request attribute.
DgsGraphQlClient.RequestSpec	attributes(Consumer<Map<String,Object>> attributesConsumer)	Manipulate the client request attributes.
DgsGraphQlClient.RequestSpec	coercing(Class<?> scalarType, Coercing<?,?> coercing)	Configure Coercing for serialization of scalar types.
DgsGraphQlClient.RequestSpec	coercing(Map<Class<?>,Coercing<?,?>> coercingMap)	Configure Coercing for serialization of scalar types.
reactor.core.publisher.Mono<ClientGraphQlResponse>	execute()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
reactor.core.publisher.Flux<ClientGraphQlResponse>	executeSubscription()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
ClientGraphQlResponse	executeSync()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
DgsGraphQlClient.RequestSpec	projection(com.netflix.graphql.dgs.client.codegen.BaseProjectionNode projectionNode)	Provide a BaseProjectionNode that defines the response selection set.
GraphQlClient.RetrieveSpec	retrieve()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
GraphQlClient.RetrieveSpec	retrieve(String path)	Variant of retrieve() with explicit path relative to the "data" key.
GraphQlClient.RetrieveSubscriptionSpec	retrieveSubscription()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
GraphQlClient.RetrieveSyncSpec	retrieveSync()	Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
GraphQlClient.RetrieveSyncSpec	retrieveSync(String path)	Variant of executeSync() with explicit path relative to the "data" key.

Methods inherited from class java.lang.Object

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

Method Details

projection

public DgsGraphQlClient.RequestSpec projection(com.netflix.graphql.dgs.client.codegen.BaseProjectionNode projectionNode)

Provide a BaseProjectionNode that defines the response selection set.

Parameters:

projectionNode - the response selection set

Returns:

ths same builder instance

coercing

public DgsGraphQlClient.RequestSpec coercing(Class<?> scalarType,
 Coercing<?,?> coercing)

Configure Coercing for serialization of scalar types.

Parameters:

scalarType - the scalar type

coercing - the coercing function for this scalar

Returns:

ths same builder instance

coercing

public DgsGraphQlClient.RequestSpec coercing(Map<Class<?>,Coercing<?,?>> coercingMap)

Configure Coercing for serialization of scalar types.

Parameters:

coercingMap - the map of coercing function

Returns:

ths same builder instance

attribute

public DgsGraphQlClient.RequestSpec attribute(String name,
 Object value)

Set a client request attribute.

This is purely for client side request processing, i.e. available throughout the GraphQlClientInterceptor chain but not sent.

Parameters:

name - the attribute name

value - the attribute value

Returns:

ths same builder instance

attributes

public DgsGraphQlClient.RequestSpec attributes(Consumer<Map<String,Object>> attributesConsumer)

Manipulate the client request attributes. The map provided to the consumer is "live", so the consumer can inspect and modify attributes accordingly.

Parameters:

attributesConsumer - the consumer that will manipulate request attributes

Returns:

ths same builder instance

retrieveSync

public GraphQlClient.RetrieveSyncSpec retrieveSync()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.retrieveSync(String) for details. The path used is the operationName.

retrieveSync

public GraphQlClient.RetrieveSyncSpec retrieveSync(String path)

Variant of executeSync() with explicit path relative to the "data" key.

Parameters:

path - the JSON path relative to the "data" key

retrieve

public GraphQlClient.RetrieveSpec retrieve()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.retrieve(String) for details. The path used is the operationName.

retrieve

public GraphQlClient.RetrieveSpec retrieve(String path)

Variant of retrieve() with explicit path relative to the "data" key.

Parameters:

path - the JSON path relative to the "data" key

retrieveSubscription

public GraphQlClient.RetrieveSubscriptionSpec retrieveSubscription()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.retrieveSubscription(String) for details. The path used is the operationName.

executeSync

public ClientGraphQlResponse executeSync()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.executeSync() for details.

execute

public reactor.core.publisher.Mono<ClientGraphQlResponse> execute()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.execute() for details.

executeSubscription

public reactor.core.publisher.Flux<ClientGraphQlResponse> executeSubscription()

Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.

See Javadoc of delegate method GraphQlClient.RequestSpec.executeSubscription() for details.