io.stargate.graphql.schema.graphqlfirst.processor

Class ResponsePayloadModel

java.lang.Object

io.stargate.graphql.schema.graphqlfirst.processor.ResponsePayloadModel

All Implemented Interfaces:

OperationModel.ReturnType

public class ResponsePayloadModel
extends Object
implements OperationModel.ReturnType

Represents a GraphQL object type that has been annotated with the cql_payload directive. This is a transient object (not mapped to a CQL table), that acts as a wrapper for operation responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponsePayloadModel.EntityField
static class	ResponsePayloadModel.TechnicalField

Constructor Summary

Constructors

Constructor and Description
ResponsePayloadModel(Optional<ResponsePayloadModel.EntityField> entityField, EnumSet<ResponsePayloadModel.TechnicalField> technicalFields)

Method Summary

Modifier and Type	Method and Description
Optional<EntityModel>	getEntity()
Optional<ResponsePayloadModel.EntityField>	getEntityField() The field in the response object that references a mapped entity (or list thereof).
EnumSet<ResponsePayloadModel.TechnicalField>	getTechnicalFields() An set of additional metadata fields that Stargate will know how to fill automatically.
boolean	isList()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponsePayloadModel

public ResponsePayloadModel(Optional<ResponsePayloadModel.EntityField> entityField,
                            EnumSet<ResponsePayloadModel.TechnicalField> technicalFields)

Method Detail

getEntityField

public Optional<ResponsePayloadModel.EntityField> getEntityField()

The field in the response object that references a mapped entity (or list thereof). There is at most one such field.

getEntity

public Optional<EntityModel> getEntity()

Specified by:

getEntity in interface OperationModel.ReturnType

isList

public boolean isList()

Specified by:

isList in interface OperationModel.ReturnType

getTechnicalFields

public EnumSet<ResponsePayloadModel.TechnicalField> getTechnicalFields()

An set of additional metadata fields that Stargate will know how to fill automatically. They have predefined names and types.