Packages

c

sangria.ast

OperationDefinition

case class OperationDefinition(operationType: OperationType = OperationType.Query, name: Option[String] = None, variables: Vector[VariableDefinition] = Vector.empty, directives: Vector[Directive] = Vector.empty, selections: Vector[Selection], comments: Vector[Comment] = Vector.empty, trailingComments: Vector[Comment] = Vector.empty, location: Option[AstLocation] = None) extends Definition with WithDirectives with SelectionContainer with Product with Serializable

A definition of a GraphQL operation.

Every GraphQL request invokes a specific operation, possibly with values to substitute into the operation's variables.

name

The name of the operation. Optional only if there is only one operation in the document. Used for selecting the specific operation to invoke in a GraphQL request.

variables

The variables that must be substituted into the operation. Values for these must be provided either by their defaults or with the GraphQL request.

See also

https://spec.graphql.org/June2018/#OperationDefinition

Linear Supertypes
Serializable, Product, Equals, SelectionContainer, WithTrailingComments, WithComments, WithDirectives, Definition, AstNode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OperationDefinition
  2. Serializable
  3. Product
  4. Equals
  5. SelectionContainer
  6. WithTrailingComments
  7. WithComments
  8. WithDirectives
  9. Definition
  10. AstNode
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OperationDefinition(operationType: OperationType = OperationType.Query, name: Option[String] = None, variables: Vector[VariableDefinition] = Vector.empty, directives: Vector[Directive] = Vector.empty, selections: Vector[Selection], comments: Vector[Comment] = Vector.empty, trailingComments: Vector[Comment] = Vector.empty, location: Option[AstLocation] = None)

    name

    The name of the operation. Optional only if there is only one operation in the document. Used for selecting the specific operation to invoke in a GraphQL request.

    variables

    The variables that must be substituted into the operation. Values for these must be provided either by their defaults or with the GraphQL request.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cacheKeyHash: Int
    Definition Classes
    AstNode
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val comments: Vector[Comment]
    Definition Classes
    OperationDefinition → WithComments
  8. val directives: Vector[Directive]
    Definition Classes
    OperationDefinition → WithDirectives
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val location: Option[AstLocation]

    Location at which this node lexically begins in the GraphQL request source code.

    Location at which this node lexically begins in the GraphQL request source code.

    Definition Classes
    OperationDefinition → SelectionContainer → AstNode
  14. val name: Option[String]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val operationType: OperationType
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def renderCompact: String
    Definition Classes
    AstNode
  21. def renderPretty: String
    Definition Classes
    AstNode
  22. val selections: Vector[Selection]
    Definition Classes
    OperationDefinition → SelectionContainer
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val trailingComments: Vector[Comment]
    Definition Classes
    OperationDefinition → WithTrailingComments
  25. val variables: Vector[VariableDefinition]
  26. def visit(onEnter: (AstNode) => VisitorCommand, onLeave: (AstNode) => VisitorCommand): OperationDefinition.this.type
    Definition Classes
    AstNode
  27. def visit(visitor: AstVisitor): OperationDefinition.this.type
    Definition Classes
    AstNode
  28. def visitAstWithState[S](schema: Schema[_, _], state: S)(visitorFn: (TypeInfo, S) => AstVisitor): S
    Definition Classes
    AstNode
  29. def visitAstWithTypeInfo(schema: Schema[_, _])(visitorFn: (TypeInfo) => AstVisitor): OperationDefinition.this.type
    Definition Classes
    AstNode
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SelectionContainer

Inherited from WithTrailingComments

Inherited from WithComments

Inherited from WithDirectives

Inherited from Definition

Inherited from AstNode

Inherited from AnyRef

Inherited from Any

Ungrouped