java.lang.Object
- com.shopify.graphql.support.AbstractQuery<_FieldShapeQuery>
- - org.topbraidlive.client.java.graphql.platform._FieldShapeQuery

public class _FieldShapeQuery
extends AbstractQuery<_FieldShapeQuery>

Metadata about a field as derived from its shape(s).

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractQuery
  _queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`_FieldShapeQuery`	`addFragmentReference(Fragment<_FieldShapeQuery> fragment)`	Adds a `_FieldShapeQuery` fragment reference at the current position of the query.
`static Fragment<_FieldShapeQuery>`	`createFragment(String name, _FieldShapeQueryDefinition queryDef)`	Creates a GraphQL "named" fragment with the specified query type definition.
`_FieldShapeQuery`	`datatype(_ResourceQueryDefinition queryDef)`	The declared datatype of the field or null if this is an object-valued field.
`_FieldShapeQuery`	`datatypes(_ResourceQueryDefinition queryDef)`	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.
`_FieldShapeQuery`	`defaultValue()`	Returns a non-empty string (encoded RDF node) if this field has a sh:defaultValue, null otherwise.
`_FieldShapeQuery`	`description()`	A human-readable description of the field.
`_FieldShapeQuery`	`editor(_ResourceQueryDefinition queryDef)`	The specified dash:editor, or null.
`_FieldShapeQuery`	`enumValues(_EnumValueQueryDefinition queryDef)`	For enumerated properties (based on sh:in) this produces an array for all members of the enumeration.
`_FieldShapeQuery`	`externalType(_ResourceQueryDefinition queryDef)`	The external type if this is an object-valued field that points at a resource outside of the GraphQL schema.
`_FieldShapeQuery`	`group(_FieldGroupQueryDefinition queryDef)`	The field group that the field is in.
`_FieldShapeQuery`	`isHidden()`	True if this field should be hidden from user interfaces.
`_FieldShapeQuery`	`isIndexed()`	True if this field is indexed, i.e.
`_FieldShapeQuery`	`isInferred()`	True if this is an inferred field, the values of which are derived or computed from other values.
`_FieldShapeQuery`	`isList()`	True if this is an rdf:List field.
`_FieldShapeQuery`	`isMaxExclusive()`	True if the value of max should be interpreted as < and not <=
`_FieldShapeQuery`	`isMinExclusive()`	True if the value of min should be interpreted as > and not >=
`_FieldShapeQuery`	`label()`	A display label for the field.
`_FieldShapeQuery`	`max()`	The maximum value of the field, if specified.
`_FieldShapeQuery`	`maxCount()`	The maximum permitted number of values of the field (if any).
`_FieldShapeQuery`	`maxLength()`	The maximum string length of values of the field (if any).
`_FieldShapeQuery`	`min()`	The minimum value of the field, if specified.
`_FieldShapeQuery`	`minCount()`	The minimum required number of values of the field, defaulting to 0.
`_FieldShapeQuery`	`minLength()`	The minimum string length of values of the field, defaulting to 0.
`_FieldShapeQuery`	`name()`	The GraphQL name of the field.
`_FieldShapeQuery`	`node()`	The URI of the sh:node constraint, defining additional filter conditions for auto-complete widgets.
`_FieldShapeQuery`	`nodeKind(_ResourceQueryDefinition queryDef)`	The declared sh:nodeKind of the field, e.g.
`_FieldShapeQuery`	`order()`	A number representing the relative ordering of this field compared to others.
`_FieldShapeQuery`	`path(_PathQueryDefinition queryDef)`	The sh:path that the field is about
`_FieldShapeQuery`	`pattern()`	The regular expression that the values of the field must match.
`_FieldShapeQuery`	`readOnly()`	True if this field has been marked to be read-only using dash:readOnly.
`_FieldShapeQuery`	`reifiableBy()`	The URI of the specified dash:reifiableBy, or null.
`_FieldShapeQuery`	`role()`	The URI of the property role, or null.
`_FieldShapeQuery`	`scalar()`	True if the GraphQL field is of a scalar type, i.e.
`_FieldShapeQuery`	`singleLine()`	True or false if the property shape has a dash:singleLine constraint, or null if none has been declared, meaning "don't know".
`_FieldShapeQuery`	`typeShape(_TypeShapeQueryDefinition queryDef)`	The type shape of the field or null if this is a datatype-valued field or an external resource.
`_FieldShapeQuery`	`unionTypeNames()`	The GraphQL names of the individual types if this field is a union type.
`_FieldShapeQuery`	`uriStart()`	The start of URIs used by all instances where this property applies as primary key, as specified using dash:uriStart.
`_FieldShapeQuery`	`viewer(_ResourceQueryDefinition queryDef)`	The specified dash:viewer, or null.
`_FieldShapeQuery`	`viewWidget()`	The URI of the specified tosh:viewWidget, or null.

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
  - datatype
```
public _FieldShapeQuery datatype(_ResourceQueryDefinition queryDef)
```
    The declared datatype of the field or null if this is an object-valued field.
  - datatypes
```
public _FieldShapeQuery datatypes(_ResourceQueryDefinition queryDef)
```
    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.
  - defaultValue
```
public _FieldShapeQuery defaultValue()
```
    Returns a non-empty string (encoded RDF node) if this field has a sh:defaultValue, null otherwise.
  - description
```
public _FieldShapeQuery description()
```
    A human-readable description of the field.
  - editor
```
public _FieldShapeQuery editor(_ResourceQueryDefinition queryDef)
```
    The specified dash:editor, or null.
  - enumValues
```
public _FieldShapeQuery enumValues(_EnumValueQueryDefinition queryDef)
```
    For enumerated properties (based on sh:in) this produces an array for all members of the enumeration.
  - externalType
```
public _FieldShapeQuery externalType(_ResourceQueryDefinition queryDef)
```
    The external type if this is an object-valued field that points at a resource outside of the GraphQL schema.
  - group
```
public _FieldShapeQuery group(_FieldGroupQueryDefinition queryDef)
```
    The field group that the field is in.
  - isHidden
```
public _FieldShapeQuery isHidden()
```
    True if this field should be hidden from user interfaces.
  - isIndexed
```
public _FieldShapeQuery isIndexed()
```
    True if this field is indexed, i.e. its values are sorted and a UI should maintain index order from 0 to n.
  - isInferred
```
public _FieldShapeQuery isInferred()
```
    True if this is an inferred field, the values of which are derived or computed from other values. Inferred fields are not mutable.
  - isList
```
public _FieldShapeQuery isList()
```
    True if this is an rdf:List field.
  - isMaxExclusive
```
public _FieldShapeQuery isMaxExclusive()
```
    True if the value of max should be interpreted as < and not <=
  - isMinExclusive
```
public _FieldShapeQuery isMinExclusive()
```
    True if the value of min should be interpreted as > and not >=
  - label
```
public _FieldShapeQuery label()
```
    A display label for the field.
  - max
```
public _FieldShapeQuery max()
```
    The maximum value of the field, if specified.
  - maxCount
```
public _FieldShapeQuery maxCount()
```
    The maximum permitted number of values of the field (if any).
  - maxLength
```
public _FieldShapeQuery maxLength()
```
    The maximum string length of values of the field (if any).
  - min
```
public _FieldShapeQuery min()
```
    The minimum value of the field, if specified.
  - minCount
```
public _FieldShapeQuery minCount()
```
    The minimum required number of values of the field, defaulting to 0.
  - minLength
```
public _FieldShapeQuery minLength()
```
    The minimum string length of values of the field, defaulting to 0.
  - name
```
public _FieldShapeQuery name()
```
    The GraphQL name of the field.
  - node
```
public _FieldShapeQuery node()
```
    The URI of the sh:node constraint, defining additional filter conditions for auto-complete widgets.
  - nodeKind
```
public _FieldShapeQuery nodeKind(_ResourceQueryDefinition queryDef)
```
    The declared sh:nodeKind of the field, e.g. sh:IRI.
  - order
```
public _FieldShapeQuery order()
```
    A number representing the relative ordering of this field compared to others. Defaults to 0.
  - path
```
public _FieldShapeQuery path(_PathQueryDefinition queryDef)
```
    The sh:path that the field is about
  - pattern
```
public _FieldShapeQuery pattern()
```
    The regular expression that the values of the field must match.
  - readOnly
```
public _FieldShapeQuery readOnly()
```
    True if this field has been marked to be read-only using dash:readOnly.
  - reifiableBy
```
public _FieldShapeQuery reifiableBy()
```
    The URI of the specified dash:reifiableBy, or null.
  - role
```
public _FieldShapeQuery role()
```
    The URI of the property role, or null.
  - scalar
```
public _FieldShapeQuery scalar()
```
    True if the GraphQL field is of a scalar type, i.e. does not have child selectors.
  - singleLine
```
public _FieldShapeQuery singleLine()
```
    True or false if the property shape has a dash:singleLine constraint, or null if none has been declared, meaning "don't know".
  - typeShape
```
public _FieldShapeQuery typeShape(_TypeShapeQueryDefinition queryDef)
```
    The type shape of the field or null if this is a datatype-valued field or an external resource.
  - unionTypeNames
```
public _FieldShapeQuery unionTypeNames()
```
    The GraphQL names of the individual types if this field is a union type.
  - uriStart
```
public _FieldShapeQuery uriStart()
```
    The start of URIs used by all instances where this property applies as primary key, as specified using dash:uriStart.
  - viewWidget
```
public _FieldShapeQuery viewWidget()
```
    The URI of the specified tosh:viewWidget, or null.
  - viewer
```
public _FieldShapeQuery viewer(_ResourceQueryDefinition queryDef)
```
    The specified dash:viewer, or null.
  - createFragment
```
public static Fragment<_FieldShapeQuery> createFragment(String name,
                                                        _FieldShapeQueryDefinition 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 _FieldShapeQuery addFragmentReference(Fragment<_FieldShapeQuery> fragment)
```
    Adds a _FieldShapeQuery 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.

Class _FieldShapeQuery

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

datatype

datatypes

defaultValue

description

editor

enumValues

externalType

group

isHidden

isIndexed

isInferred

isList

isMaxExclusive

isMinExclusive

label

max

maxCount

maxLength

min

minCount

minLength

name

node

nodeKind

order

path

pattern

readOnly

reifiableBy

role

scalar

singleLine

typeShape

unionTypeNames

uriStart

viewWidget

viewer

createFragment

addFragmentReference