com.apollographql.apollo.api

Interface Operation<D extends Operation.Data,T,V extends Operation.Variables>

All Known Subinterfaces:

Mutation<D,T,V>, Query<D,T,V>, Subscription<D,T,V>

public interface Operation<D extends Operation.Data,T,V extends Operation.Variables>

Represents a GraphQL operation (mutation or query).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Operation.Data Abstraction for data returned by the server in response to this operation.
static class	Operation.Variables Abstraction for the variables which are a part of the GraphQL operation.

Field Summary

Fields

Modifier and Type	Field and Description
static Operation.Variables	EMPTY_VARIABLES

Method Summary

Modifier and Type	Method and Description
OperationName	name() Returns GraphQL operation name.
java.lang.String	operationId() Returns a unique identifier for this operation.
java.lang.String	queryDocument() Returns the raw GraphQL operation String.
ResponseFieldMapper<D>	responseFieldMapper() Returns a mapper that maps the server response data to generated model class D.
V	variables() Returns the variables associated with this GraphQL operation.
T	wrapData(D data) Wraps the generated response data class D with another class.

Field Detail

EMPTY_VARIABLES

static final Operation.Variables EMPTY_VARIABLES

Method Detail

queryDocument

java.lang.String queryDocument()

Returns the raw GraphQL operation String.

variables

V variables()

Returns the variables associated with this GraphQL operation.

responseFieldMapper

ResponseFieldMapper<D> responseFieldMapper()

Returns a mapper that maps the server response data to generated model class D.

wrapData

T wrapData(D data)

Wraps the generated response data class D with another class. For example, a use case for this would be to wrap the generated response data class in an Optional i.e. Optional.fromNullable(data).

name

@Nonnull
OperationName name()

Returns GraphQL operation name.

Returns:

OperationName operation name

operationId

@Nonnull
java.lang.String operationId()

Returns a unique identifier for this operation.

Returns:

operation identifier.