com.adobe.cq.commerce.magento.graphql

Class __Directive

java.lang.Object

com.shopify.graphql.support.AbstractResponse<__Directive>

com.adobe.cq.commerce.magento.graphql.__Directive

All Implemented Interfaces:

Serializable

public class __Directive
extends AbstractResponse<__Directive>

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
__Directive()
__Directive(com.google.gson.JsonObject fields)

Method Summary

Modifier and Type	Method and Description
List<__InputValue>	getArgs()
String	getDescription()
String	getGraphQlTypeName()
List<__DirectiveLocation>	getLocations()
String	getName()
Boolean	getOnField() Deprecated. Use `locations`.
Boolean	getOnFragment() Deprecated. Use `locations`.
Boolean	getOnOperation() Deprecated. Use `locations`.
__Directive	setArgs(List<__InputValue> arg)
__Directive	setDescription(String arg)
__Directive	setLocations(List<__DirectiveLocation> arg)
__Directive	setName(String arg)
__Directive	setOnField(Boolean arg)
__Directive	setOnFragment(Boolean arg)
__Directive	setOnOperation(Boolean arg)
boolean	unwrapsToObject(String key)

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

collectNodes, get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, readCustomField, withAlias

Methods inherited from class java.lang.Object

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

Constructor Detail

__Directive

public __Directive()

__Directive

public __Directive(com.google.gson.JsonObject fields)
            throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public String getGraphQlTypeName()

getName

public String getName()

setName

public __Directive setName(String arg)

getDescription

public String getDescription()

setDescription

public __Directive setDescription(String arg)

getLocations

public List<__DirectiveLocation> getLocations()

setLocations

public __Directive setLocations(List<__DirectiveLocation> arg)

getArgs

public List<__InputValue> getArgs()

setArgs

public __Directive setArgs(List<__InputValue> arg)

getOnOperation

@Deprecated
public Boolean getOnOperation()

Deprecated. Use `locations`.

setOnOperation

public __Directive setOnOperation(Boolean arg)

getOnFragment

@Deprecated
public Boolean getOnFragment()

Deprecated. Use `locations`.

setOnFragment

public __Directive setOnFragment(Boolean arg)

getOnField

@Deprecated
public Boolean getOnField()

Deprecated. Use `locations`.

setOnField

public __Directive setOnField(Boolean arg)

unwrapsToObject

public boolean unwrapsToObject(String key)

Specified by:

unwrapsToObject in class AbstractResponse<__Directive>