Package org.springframework.graphql.client

Interface GraphQlClient.RetrieveSpec

Enclosing interface:

GraphQlClient

public static interface GraphQlClient.RetrieveSpec

Declares options to decode a field for a single response operation.

Method Summary

Modifier and Type	Method	Description
<D> reactor.core.publisher.Mono<D>	toEntity(Class<D> entityType)	Decode the field to an entity of the given type.
<D> reactor.core.publisher.Mono<D>	toEntity(ParameterizedTypeReference<D> entityType)	Variant of toEntity(Class) with a ParameterizedTypeReference.
<D> reactor.core.publisher.Mono<List<D>>	toEntityList(Class<D> elementType)	Decode the field to a list of entities with the given type.
<D> reactor.core.publisher.Mono<List<D>>	toEntityList(ParameterizedTypeReference<D> elementType)	Variant of toEntityList(Class) with ParameterizedTypeReference.

Method Details

toEntity

<D> reactor.core.publisher.Mono<D> toEntity(Class<D> entityType)

Decode the field to an entity of the given type.

Parameters:

entityType - the type to convert to

Returns:

Mono with the decoded entity. Completes empty when the field is null without errors, or ends with FieldAccessException for an invalid response or a failed field

See Also:

• GraphQlResponse.isValid()
• ResponseField.getError()

toEntity

<D> reactor.core.publisher.Mono<D> toEntity(ParameterizedTypeReference<D> entityType)

Variant of toEntity(Class) with a ParameterizedTypeReference.

toEntityList

<D> reactor.core.publisher.Mono<List<D>> toEntityList(Class<D> elementType)

Decode the field to a list of entities with the given type.

Parameters:

elementType - the type of elements in the list

Returns:

Mono with a list of decoded entities, possibly an empty list, or ends with FieldAccessException if the target field is not present or has no value.

See Also:

• GraphQlResponse.isValid()
• ResponseField.getError()

toEntityList

<D> reactor.core.publisher.Mono<List<D>> toEntityList(ParameterizedTypeReference<D> elementType)

Variant of toEntityList(Class) with ParameterizedTypeReference.