java.lang.Object
- com.shopify.graphql.support.AbstractResponse<_FieldShape>
- - org.topbraidlive.client.java.graphql.platform._FieldShape

All Implemented Interfaces:

Serializable
```
public class _FieldShape
extends AbstractResponse<_FieldShape>
```
Metadata about a field as derived from its shape(s).

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor Description

_FieldShape()

_FieldShape(com.google.gson.JsonObject fields)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`_Resource`	`getDatatype()`	The declared datatype of the field or null if this is an object-valued field.
`List<_Resource>`	`getDatatypes()`	Produces the individual datatypes if this field is based on a sh:or of multiple datatypes (indicated by having datatype rdfs:Literal), otherwise behaves like datatype introspection.
`String`	`getDefaultValue()`	Returns a non-empty string (encoded RDF node) if this field has a sh:defaultValue, null otherwise.
`String`	`getDescription()`	A human-readable description of the field.
`_Resource`	`getEditor()`	The specified dash:editor, or null.
`List<_EnumValue>`	`getEnumValues()`	For enumerated properties (based on sh:in) this produces an array for all members of the enumeration.
`_Resource`	`getExternalType()`	The external type if this is an object-valued field that points at a resource outside of the GraphQL schema.
`String`	`getGraphQlTypeName()`
`_FieldGroup`	`getGroup()`	The field group that the field is in.
`Boolean`	`getIsHidden()`	True if this field should be hidden from user interfaces.
`Boolean`	`getIsIndexed()`	True if this field is indexed, i.e.
`Boolean`	`getIsInferred()`	True if this is an inferred field, the values of which are derived or computed from other values.
`Boolean`	`getIsList()`	True if this is an rdf:List field.
`Boolean`	`getIsMaxExclusive()`	True if the value of max should be interpreted as < and not <=
`Boolean`	`getIsMinExclusive()`	True if the value of min should be interpreted as > and not >=
`String`	`getLabel()`	A display label for the field.
`String`	`getMax()`	The maximum value of the field, if specified.
`Integer`	`getMaxCount()`	The maximum permitted number of values of the field (if any).
`Integer`	`getMaxLength()`	The maximum string length of values of the field (if any).
`String`	`getMin()`	The minimum value of the field, if specified.
`Integer`	`getMinCount()`	The minimum required number of values of the field, defaulting to 0.
`Integer`	`getMinLength()`	The minimum string length of values of the field, defaulting to 0.
`String`	`getName()`	The GraphQL name of the field.
`String`	`getNode()`	The URI of the sh:node constraint, defining additional filter conditions for auto-complete widgets.
`_Resource`	`getNodeKind()`	The declared sh:nodeKind of the field, e.g.
`Double`	`getOrder()`	A number representing the relative ordering of this field compared to others.
`_Path`	`getPath()`	The sh:path that the field is about
`String`	`getPattern()`	The regular expression that the values of the field must match.
`Boolean`	`getReadOnly()`	True if this field has been marked to be read-only using dash:readOnly.
`String`	`getReifiableBy()`	The URI of the specified dash:reifiableBy, or null.
`String`	`getRole()`	The URI of the property role, or null.
`Boolean`	`getScalar()`	True if the GraphQL field is of a scalar type, i.e.
`Boolean`	`getSingleLine()`	True or false if the property shape has a dash:singleLine constraint, or null if none has been declared, meaning "don't know".
`_TypeShape`	`getTypeShape()`	The type shape of the field or null if this is a datatype-valued field or an external resource.
`List<String>`	`getUnionTypeNames()`	The GraphQL names of the individual types if this field is a union type.
`String`	`getUriStart()`	The start of URIs used by all instances where this property applies as primary key, as specified using dash:uriStart.
`_Resource`	`getViewer()`	The specified dash:viewer, or null.
`String`	`getViewWidget()`	The URI of the specified tosh:viewWidget, or null.
`_FieldShape`	`setDatatype(_Resource arg)`
`_FieldShape`	`setDatatypes(List<_Resource> arg)`
`_FieldShape`	`setDefaultValue(String arg)`
`_FieldShape`	`setDescription(String arg)`
`_FieldShape`	`setEditor(_Resource arg)`
`_FieldShape`	`setEnumValues(List<_EnumValue> arg)`
`_FieldShape`	`setExternalType(_Resource arg)`
`_FieldShape`	`setGroup(_FieldGroup arg)`
`_FieldShape`	`setIsHidden(Boolean arg)`
`_FieldShape`	`setIsIndexed(Boolean arg)`
`_FieldShape`	`setIsInferred(Boolean arg)`
`_FieldShape`	`setIsList(Boolean arg)`
`_FieldShape`	`setIsMaxExclusive(Boolean arg)`
`_FieldShape`	`setIsMinExclusive(Boolean arg)`
`_FieldShape`	`setLabel(String arg)`
`_FieldShape`	`setMax(String arg)`
`_FieldShape`	`setMaxCount(Integer arg)`
`_FieldShape`	`setMaxLength(Integer arg)`
`_FieldShape`	`setMin(String arg)`
`_FieldShape`	`setMinCount(Integer arg)`
`_FieldShape`	`setMinLength(Integer arg)`
`_FieldShape`	`setName(String arg)`
`_FieldShape`	`setNode(String arg)`
`_FieldShape`	`setNodeKind(_Resource arg)`
`_FieldShape`	`setOrder(Double arg)`
`_FieldShape`	`setPath(_Path arg)`
`_FieldShape`	`setPattern(String arg)`
`_FieldShape`	`setReadOnly(Boolean arg)`
`_FieldShape`	`setReifiableBy(String arg)`
`_FieldShape`	`setRole(String arg)`
`_FieldShape`	`setScalar(Boolean arg)`
`_FieldShape`	`setSingleLine(Boolean arg)`
`_FieldShape`	`setTypeShape(_TypeShape arg)`
`_FieldShape`	`setUnionTypeNames(List<String> arg)`
`_FieldShape`	`setUriStart(String arg)`
`_FieldShape`	`setViewer(_Resource arg)`
`_FieldShape`	`setViewWidget(String 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
  - _FieldShape
```
public _FieldShape()
```
  - _FieldShape
```
public _FieldShape(com.google.gson.JsonObject fields)
            throws SchemaViolationError
```
    Throws:
    
    SchemaViolationError
- Method Detail
  - getGraphQlTypeName
```
public String getGraphQlTypeName()
```
  - getName
```
public String getName()
```
    The GraphQL name of the field.
  - setName
```
public _FieldShape setName(String arg)
```
  - getLabel
```
public String getLabel()
```
    A display label for the field.
  - setLabel
```
public _FieldShape setLabel(String arg)
```
  - getDescription
```
public String getDescription()
```
    A human-readable description of the field.
  - setDescription
```
public _FieldShape setDescription(String arg)
```
  - getDatatype
```
public _Resource getDatatype()
```
    The declared datatype of the field or null if this is an object-valued field.
  - setDatatype
```
public _FieldShape setDatatype(_Resource arg)
```
  - getDatatypes
```
public List<_Resource> getDatatypes()
```
    Produces the individual datatypes if this field is based on a sh:or of multiple datatypes (indicated by having datatype rdfs:Literal), otherwise behaves like datatype introspection.
  - setDatatypes
```
public _FieldShape setDatatypes(List<_Resource> arg)
```
  - getEnumValues
```
public List<_EnumValue> getEnumValues()
```
    For enumerated properties (based on sh:in) this produces an array for all members of the enumeration.
  - setEnumValues
```
public _FieldShape setEnumValues(List<_EnumValue> arg)
```
  - getExternalType
```
public _Resource getExternalType()
```
    The external type if this is an object-valued field that points at a resource outside of the GraphQL schema.
  - setExternalType
```
public _FieldShape setExternalType(_Resource arg)
```
  - getNode
```
public String getNode()
```
    The URI of the sh:node constraint, defining additional filter conditions for auto-complete widgets.
  - setNode
```
public _FieldShape setNode(String arg)
```
  - getTypeShape
```
public _TypeShape getTypeShape()
```
    The type shape of the field or null if this is a datatype-valued field or an external resource.
  - setTypeShape
```
public _FieldShape setTypeShape(_TypeShape arg)
```
  - getScalar
```
public Boolean getScalar()
```
    True if the GraphQL field is of a scalar type, i.e. does not have child selectors.
  - setScalar
```
public _FieldShape setScalar(Boolean arg)
```
  - getSingleLine
```
public Boolean getSingleLine()
```
    True or false if the property shape has a dash:singleLine constraint, or null if none has been declared, meaning "don't know".
  - setSingleLine
```
public _FieldShape setSingleLine(Boolean arg)
```
  - getUnionTypeNames
```
public List<String> getUnionTypeNames()
```
    The GraphQL names of the individual types if this field is a union type.
  - setUnionTypeNames
```
public _FieldShape setUnionTypeNames(List<String> arg)
```
  - getMinCount
```
public Integer getMinCount()
```
    The minimum required number of values of the field, defaulting to 0.
  - setMinCount
```
public _FieldShape setMinCount(Integer arg)
```
  - getMaxCount
```
public Integer getMaxCount()
```
    The maximum permitted number of values of the field (if any).
  - setMaxCount
```
public _FieldShape setMaxCount(Integer arg)
```
  - getMin
```
public String getMin()
```
    The minimum value of the field, if specified.
  - setMin
```
public _FieldShape setMin(String arg)
```
  - getMax
```
public String getMax()
```
    The maximum value of the field, if specified.
  - setMax
```
public _FieldShape setMax(String arg)
```
  - getIsMinExclusive
```
public Boolean getIsMinExclusive()
```
    True if the value of min should be interpreted as > and not >=
  - setIsMinExclusive
```
public _FieldShape setIsMinExclusive(Boolean arg)
```
  - getIsMaxExclusive
```
public Boolean getIsMaxExclusive()
```
    True if the value of max should be interpreted as < and not <=
  - setIsMaxExclusive
```
public _FieldShape setIsMaxExclusive(Boolean arg)
```
  - getMinLength
```
public Integer getMinLength()
```
    The minimum string length of values of the field, defaulting to 0.
  - setMinLength
```
public _FieldShape setMinLength(Integer arg)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    The maximum string length of values of the field (if any).
  - setMaxLength
```
public _FieldShape setMaxLength(Integer arg)
```
  - getNodeKind
```
public _Resource getNodeKind()
```
    The declared sh:nodeKind of the field, e.g. sh:IRI.
  - setNodeKind
```
public _FieldShape setNodeKind(_Resource arg)
```
  - getPattern
```
public String getPattern()
```
    The regular expression that the values of the field must match.
  - setPattern
```
public _FieldShape setPattern(String arg)
```
  - getGroup
```
public _FieldGroup getGroup()
```
    The field group that the field is in.
  - setGroup
```
public _FieldShape setGroup(_FieldGroup arg)
```
  - getOrder
```
public Double getOrder()
```
    A number representing the relative ordering of this field compared to others. Defaults to 0.
  - setOrder
```
public _FieldShape setOrder(Double arg)
```
  - getRole
```
public String getRole()
```
    The URI of the property role, or null.
  - setRole
```
public _FieldShape setRole(String arg)
```
  - getEditor
```
public _Resource getEditor()
```
    The specified dash:editor, or null.
  - setEditor
```
public _FieldShape setEditor(_Resource arg)
```
  - getViewWidget
```
public String getViewWidget()
```
    The URI of the specified tosh:viewWidget, or null.
  - setViewWidget
```
public _FieldShape setViewWidget(String arg)
```
  - getViewer
```
public _Resource getViewer()
```
    The specified dash:viewer, or null.
  - setViewer
```
public _FieldShape setViewer(_Resource arg)
```
  - getPath
```
public _Path getPath()
```
    The sh:path that the field is about
  - setPath
```
public _FieldShape setPath(_Path arg)
```
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns a non-empty string (encoded RDF node) if this field has a sh:defaultValue, null otherwise.
  - setDefaultValue
```
public _FieldShape setDefaultValue(String arg)
```
  - getIsHidden
```
public Boolean getIsHidden()
```
    True if this field should be hidden from user interfaces.
  - setIsHidden
```
public _FieldShape setIsHidden(Boolean arg)
```
  - getIsIndexed
```
public Boolean getIsIndexed()
```
    True if this field is indexed, i.e. its values are sorted and a UI should maintain index order from 0 to n.
  - setIsIndexed
```
public _FieldShape setIsIndexed(Boolean arg)
```
  - getIsInferred
```
public Boolean getIsInferred()
```
    True if this is an inferred field, the values of which are derived or computed from other values. Inferred fields are not mutable.
  - setIsInferred
```
public _FieldShape setIsInferred(Boolean arg)
```
  - getIsList
```
public Boolean getIsList()
```
    True if this is an rdf:List field.
  - setIsList
```
public _FieldShape setIsList(Boolean arg)
```
  - getReadOnly
```
public Boolean getReadOnly()
```
    True if this field has been marked to be read-only using dash:readOnly.
  - setReadOnly
```
public _FieldShape setReadOnly(Boolean arg)
```
  - getReifiableBy
```
public String getReifiableBy()
```
    The URI of the specified dash:reifiableBy, or null.
  - setReifiableBy
```
public _FieldShape setReifiableBy(String arg)
```
  - getUriStart
```
public String getUriStart()
```
    The start of URIs used by all instances where this property applies as primary key, as specified using dash:uriStart.
  - setUriStart
```
public _FieldShape setUriStart(String arg)
```
  - unwrapsToObject
```
public boolean unwrapsToObject(String key)
```
    Specified by:
    
    unwrapsToObject in class AbstractResponse<_FieldShape>

Constructor	Description
`_FieldShape()`
`_FieldShape(com.google.gson.JsonObject fields)`

Class _FieldShape

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

_FieldShape

_FieldShape

Method Detail

getGraphQlTypeName

getName

setName

getLabel

setLabel

getDescription

setDescription

getDatatype

setDatatype

getDatatypes

setDatatypes

getEnumValues

setEnumValues

getExternalType

setExternalType

getNode

setNode

getTypeShape

setTypeShape

getScalar

setScalar

getSingleLine

setSingleLine

getUnionTypeNames

setUnionTypeNames

getMinCount

setMinCount

getMaxCount

setMaxCount

getMin

setMin

getMax

setMax

getIsMinExclusive

setIsMinExclusive

getIsMaxExclusive

setIsMaxExclusive

getMinLength

setMinLength

getMaxLength

setMaxLength

getNodeKind

setNodeKind

getPattern

setPattern

getGroup

setGroup

getOrder

setOrder

getRole

setRole

getEditor

setEditor

getViewWidget

setViewWidget

getViewer

setViewer

getPath

setPath

getDefaultValue

setDefaultValue

getIsHidden

setIsHidden

getIsIndexed

setIsIndexed

getIsInferred

setIsInferred

getIsList

setIsList