org.springframework.graphql.client

Interface GraphQlClient.RetrieveSubscriptionSpec

Enclosing interface:

GraphQlClient

public static interface GraphQlClient.RetrieveSubscriptionSpec

Declares options to decode a field in each response of a subscription.

Method Summary

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

Method Detail

toEntity

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

Decode the field to an entity of the given type.

Parameters:

entityType - the type to convert to

Returns:

a stream of decoded entities, one for each response, excluding responses in which the field is null without errors. Ends with FieldAccessException for an invalid response or a failed field. May also end with a GraphQlTransportException.

See Also:

GraphQlResponse.isValid(), ResponseField.getError()

toEntity

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

Variant of toEntity(Class) with a ParameterizedTypeReference.

toEntityList

<D> reactor.core.publisher.Flux<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:

lists of decoded entities, one for each response, excluding responses in which the field is null without errors. Ends with FieldAccessException for an invalid response or a failed field. May also end with a GraphQlTransportException.

See Also:

GraphQlResponse.isValid(), ResponseField.getError()

toEntityList

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

Variant of toEntityList(Class) with ParameterizedTypeReference.