Viaduct JavaAPI API/viaduct.java.api.types

Package-level declarations

Java API for Viaduct GraphQL types.

All types in this package and subpackages are non-null by default unless explicitly annotated with @Nullable.

Types

Arguments

interface Arguments : InputLike

Tagging interface for virtual input types that wrap field arguments.

BackwardConnectionArguments

interface BackwardConnectionArguments : ConnectionArguments

Arguments for backward pagination through a connection.

CompositeOutput

interface CompositeOutput : GRT

Tagging interface for output types that have fields, i.e.

Connection

interface Connection<E : Edge<N>?, N> : GraphQLObject

A paginated list of Edges plus a pageInfo object describing page boundaries.

ConnectionArguments

interface ConnectionArguments : Arguments

Typed access to the pagination inputs (first, after, last,


before

) of a connection field.

Edge

interface Edge<N> : GraphQLObject

A wrapper around a node that also carries a cursor encoding the item's position in the list.

ForwardConnectionArguments

interface ForwardConnectionArguments : ConnectionArguments

Arguments for forward pagination through a connection.

GraphQLEnum

interface GraphQLEnum : GRT

Tagging interface for GraphQL enum types.

GraphQLInput

interface GraphQLInput : InputLike

Tagging interface for GraphQL input types.

GraphQLInterface

interface GraphQLInterface : CompositeOutput

Tagging interface for GraphQL interface types.

GraphQLObject

interface GraphQLObject : GraphQLInterface

Tagging interface for GraphQL object types.

GraphQLUnion

interface GraphQLUnion : CompositeOutput

Tagging interface for GraphQL union types.

GRT

interface GRT

Base interface for all GraphQL Representational Types (GRTs).

InputLike

interface InputLike : GRT

Tagging interface for input types and virtual input types that wrap field arguments.

MultidirectionalConnectionArguments

interface MultidirectionalConnectionArguments : ForwardConnectionArguments, BackwardConnectionArguments

Arguments for connections that expose all four pagination args (first, after, last, before).

Mutation

interface Mutation : GraphQLObject

Tagging interface for the root mutation object.

NodeCompositeOutput

interface NodeCompositeOutput : CompositeOutput

Tagging interface for types that implement the Node interface.

NodeObject

interface NodeObject : GraphQLObject, NodeCompositeOutput

Tagging interface for object types that implement the GraphQL Node interface.

OffsetCursor

class OffsetCursor

A cursor for offset-based pagination.

OffsetLimit

class OffsetLimit : Record

Result of converting ConnectionArguments to an offset/limit pair.

Query

interface Query : GraphQLObject

Tagging interface for the root query object.