com.adobe.cq.commerce.magento.graphql

Class __SchemaQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<__SchemaQuery>

com.adobe.cq.commerce.magento.graphql.__SchemaQuery

public class __SchemaQuery
extends AbstractQuery<__SchemaQuery>

A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
__SchemaQuery	addFragmentReference(Fragment<__SchemaQuery> fragment) Adds a __SchemaQuery fragment reference at the current position of the query.
static Fragment<__SchemaQuery>	createFragment(String name, __SchemaQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
__SchemaQuery	directives(__DirectiveQueryDefinition queryDef) A list of all directives supported by this server.
__SchemaQuery	mutationType(__TypeQueryDefinition queryDef) If this server supports mutation, the type that mutation operations will be rooted at.
__SchemaQuery	queryType(__TypeQueryDefinition queryDef) The type that query operations will be rooted at.
__SchemaQuery	subscriptionType(__TypeQueryDefinition queryDef) If this server support subscription, the type that subscription operations will be rooted at.
__SchemaQuery	types(__TypeQueryDefinition queryDef) A list of all types supported by this server.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

directives

public __SchemaQuery directives(__DirectiveQueryDefinition queryDef)

A list of all directives supported by this server.

mutationType

public __SchemaQuery mutationType(__TypeQueryDefinition queryDef)

If this server supports mutation, the type that mutation operations will be rooted at.

queryType

public __SchemaQuery queryType(__TypeQueryDefinition queryDef)

The type that query operations will be rooted at.

subscriptionType

public __SchemaQuery subscriptionType(__TypeQueryDefinition queryDef)

If this server support subscription, the type that subscription operations will be rooted at.

types

public __SchemaQuery types(__TypeQueryDefinition queryDef)

A list of all types supported by this server.

createFragment

public static Fragment<__SchemaQuery> createFragment(String name,
                                                     __SchemaQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public __SchemaQuery addFragmentReference(Fragment<__SchemaQuery> fragment)

Adds a __SchemaQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.