GraphQLMapping (GORM GraphQL

org.grails.gorm.graphql.entity.dsl.GraphQLMapping

All Implemented Interfaces and Traits:: Deprecatable, Describable, ExecutesClosures

@groovy.transform.CompileStatic
class GraphQLMapping

DSL to provide GraphQL specific data for a GORM entity Usage:

 static graphql = {
     exclude 'foo'
     add('bar', String)
     description 'Business users'
 
 //OR: For code completion
 static graphql = GraphQLMapping.build {
     ...
 }

Authors:: James Kleeh

Since:: 1.0.0

Properties Summary

Properties
Type	Name and description
`java.util.Set<java.lang.String>`	`excluded`
`Operations`	`operations`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(CustomGraphQLProperty property)` Add a new property to be included in the schema.
	`void`	`add(java.lang.String name, java.lang.Class type, groovy.lang.Closure closure = null)` Add a new property to be included in the schema.
	`void`	`add(java.lang.String name, java.util.List<java.lang.Class> type, groovy.lang.Closure closure = null)` Add a new property to be included in the schema.
	`void`	`add(java.lang.String name, java.lang.String typeName, groovy.lang.Closure closure)` Add a new property to be included in the schema.
	`static GraphQLMapping`	`build(groovy.lang.Closure closure)` Builder to provide code completion
	`void`	`exclude(java.lang.String... properties)` Exclude one or more properties from being included in the schema
	`java.util.List<CustomGraphQLProperty>`	`getAdditional()`
	`java.util.List<CustomOperation>`	`getCustomMutationOperations()`
	`java.util.List<CustomOperation>`	`getCustomQueryOperations()`
	`java.util.Map<java.lang.String, GraphQLPropertyMapping>`	`getPropertyMappings()`
	`static LazyGraphQLMapping`	`lazy(groovy.lang.Closure closure)` Builder to provide code completion.
	`java.lang.Object`	`methodMissing(java.lang.String name, java.lang.Object args)` Supplies configuration for an existing property
	`void`	`mutation(java.lang.String name, java.lang.String typeName, groovy.lang.Closure closure)` Builds a custom mutation operation with a complex type to be built in the provided closure.
	`void`	`mutation(java.lang.String name, java.lang.Class type, groovy.lang.Closure closure)` Builds a custom mutation operation.
	`void`	`mutation(java.lang.String name, java.util.List<java.lang.Class> type, groovy.lang.Closure closure)` Builds a custom mutation operation.
	`PaginatedType`	`pagedResult(java.lang.Class type)` Denotes the return type of an operation should be paginated
	`GraphQLPropertyMapping`	`property(java.lang.String name, groovy.lang.Closure closure)` Supply metadata about an existing property
	`GraphQLPropertyMapping`	`property(java.lang.String name, java.util.Map namedArgs)` Supply metadata about an existing property
	`GraphQLPropertyMapping`	`property(java.util.Map namedArgs, java.lang.String name)` Supply metadata about an existing property
	`GraphQLPropertyMapping`	`property(java.lang.String name, GraphQLPropertyMapping mapping)` Supply metadata about an existing property
	`void`	`query(java.lang.String name, java.lang.String typeName, groovy.lang.Closure closure)` Builds a custom query operation with a complex type to be built in the provided closure.
	`void`	`query(java.lang.String name, java.util.List<java.lang.Class> type, groovy.lang.Closure closure)` Builds a custom query operation.
	`void`	`query(java.lang.String name, java.lang.Class type, groovy.lang.Closure closure)` Builds a custom query operation.
	`void`	`query(java.lang.String name, PaginatedType type, groovy.lang.Closure closure)` Builds a custom query operation that returns a paginated result.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.util.Set<java.lang.String> excluded
  - Operations operations
- Method Detail
  - void add(CustomGraphQLProperty property)
    
    Add a new property to be included in the schema. The property may or may not be backed by an instance method depending on whether or not the property is to be used for response.
    Parameters:
    property - The property to include
  - void add(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure = null)
    
    Add a new property to be included in the schema. The property may or may not be backed by an instance method depending on whether or not the property is to be used as a part of a response.
    Parameters:
    name - The name of property to include
    type - The returnType of property to include
    closure - A closure to further configure the property
  - void add(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure = null)
    
    Add a new property to be included in the schema. The property may or may not be backed by an instance method depending on whether or not the property is to be used as a part of a response. The provided list must contain exactly 1 element that is a class.
    Parameters:
    name - The name of property to include
    type - The returnType of property to include
    closure - A closure to further configure the property
  - void add(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Add a new property to be included in the schema. The property may or may not be backed by an instance method depending on whether or not the property is to be used for response. Use this method to define a complex type for the property with the returns block.
    Parameters:
    name - The name of property to include
    typeName - The name of the custom type being created
    closure - A closure to further configure the property
  - static GraphQLMapping build(@groovy.lang.DelegatesTo(value = GraphQLMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builder to provide code completion
    Parameters:
    closure - The closure to execute in the context of a mapping
    Returns:
    The mapping instance
  - void exclude(java.lang.String... properties)
    
    Exclude one or more properties from being included in the schema
    Parameters:
    properties - One or more property names
  - java.util.List<CustomGraphQLProperty> getAdditional()
  - java.util.List<CustomOperation> getCustomMutationOperations()
  - java.util.List<CustomOperation> getCustomQueryOperations()
  - java.util.Map<java.lang.String, GraphQLPropertyMapping> getPropertyMappings()
  - static LazyGraphQLMapping lazy(@groovy.lang.DelegatesTo(value = GraphQLMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builder to provide code completion. The mapping instance will not be evaluated until the schema is being generated
    Parameters:
    closure - The closure to execute in the context of a mapping
    Returns:
    The mapping instance
  - @groovy.transform.CompileDynamic java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)
    
    Supplies configuration for an existing property Usage: foo { description "Foo" } foo description: "Foo" //Provides code completion foo GraphQLPropertyMapping.build { description("Foo") }
    See Also:
    GraphQLPropertyMapping
  - void mutation(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom mutation operation with a complex type to be built in the provided closure.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    typeName - The name of the custom type returned from the operation
    closure - The closure to build the operation
  - void mutation(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom mutation operation.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    type - The return type. May be an enum, simple class, or domain class.
    closure - The closure to build the operation
  - void mutation(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom mutation operation. The provided list must ontain exactly 1 element that is a class. This method indicates the return type will be a list.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    type - The return type. A list with exactly 1 element that is a class. The class may be an enum, simple type, or domain class.
    closure - The closure to build the operation
  - PaginatedType pagedResult(java.lang.Class type)
    
    Denotes the return type of an operation should be paginated
    Parameters:
    type - The domain class being returned
    Returns:
    The type holder
  - GraphQLPropertyMapping property(java.lang.String name, @groovy.lang.DelegatesTo(value = GraphQLPropertyMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Supply metadata about an existing property
    Parameters:
    name - The property name
    closure - The closure to build the metadata
    Returns:
    The property mapping instance
  - GraphQLPropertyMapping property(java.lang.String name, java.util.Map namedArgs)
    
    Supply metadata about an existing property Example: property('foo', [input: false])
    Parameters:
    name - The property name
    namedArgs - The arguments to build the mapping
    Returns:
    The property mapping instance
  - GraphQLPropertyMapping property(java.util.Map namedArgs, java.lang.String name)
    
    Supply metadata about an existing property Example: property('foo', input: false)
    Parameters:
    name - The property name
    namedArgs - The arguments to build the mapping
    Returns:
    The property mapping instance
  - GraphQLPropertyMapping property(java.lang.String name, GraphQLPropertyMapping mapping)
    
    Supply metadata about an existing property
    Parameters:
    name - The property name
    mapping - The property mapping instance
    Returns:
    The property mapping instance provided
  - void query(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom query operation with a complex type to be built in the provided closure.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    typeName - The name of the custom type returned from the operation
    closure - The closure to build the operation
  - void query(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom query operation. The provided list must ontain exactly 1 element that is a class. This method indicates the return type will be a list.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    type - The return type. A list with exactly 1 element that is a class. The class may be an enum, simple type, or domain class.
    closure - The closure to build the operation
  - void query(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom query operation.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    type - The return type. May be an enum, simple class, or domain class.
    closure - The closure to build the operation
  - void query(java.lang.String name, PaginatedType type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)
    
    Builds a custom query operation that returns a paginated result.
    Parameters:
    name - The name used by clients of the GraphQL API to execute the operation
    type - The return type. May be an enum, simple class, or domain class.
    closure - The closure to build the operation

Summary:
Property
Method

| Detail:
Property
Method

[Groovy] Class GraphQLMapping

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Set<java.lang.String> excluded

Operations operations

Method Detail

void add(CustomGraphQLProperty property)

void add(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure = null)

void add(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure = null)

void add(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexGraphQLProperty, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

static GraphQLMapping build(@groovy.lang.DelegatesTo(value = GraphQLMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void exclude(java.lang.String... properties)

java.util.List<CustomGraphQLProperty> getAdditional()

java.util.List<CustomOperation> getCustomMutationOperations()

java.util.List<CustomOperation> getCustomQueryOperations()

java.util.Map<java.lang.String, GraphQLPropertyMapping> getPropertyMappings()

static LazyGraphQLMapping lazy(@groovy.lang.DelegatesTo(value = GraphQLMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

@groovy.transform.CompileDynamic java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)

void mutation(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void mutation(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void mutation(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

PaginatedType pagedResult(java.lang.Class type)

GraphQLPropertyMapping property(java.lang.String name, @groovy.lang.DelegatesTo(value = GraphQLPropertyMapping, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

GraphQLPropertyMapping property(java.lang.String name, java.util.Map namedArgs)

GraphQLPropertyMapping property(java.util.Map namedArgs, java.lang.String name)

GraphQLPropertyMapping property(java.lang.String name, GraphQLPropertyMapping mapping)

void query(java.lang.String name, java.lang.String typeName, @groovy.lang.DelegatesTo(value = ComplexOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void query(java.lang.String name, java.util.List<java.lang.Class> type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void query(java.lang.String name, java.lang.Class type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)

void query(java.lang.String name, PaginatedType type, @groovy.lang.DelegatesTo(value = SimpleOperation, strategy = Closure.DELEGATE_ONLY) groovy.lang.Closure closure)