Package org.topbraidlive.client.java.graphql.platform

Class ConstraintReificationShapeQuery

java.lang.Object

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

org.topbraidlive.client.java.graphql.platform.ConstraintReificationShapeQuery

public class ConstraintReificationShapeQuery
extends AbstractQuery<ConstraintReificationShapeQuery>

Can be used to attach sh:severity and sh:messages to individual constraints using reification.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ConstraintReificationShapeQuery.MessageArguments
static interface	ConstraintReificationShapeQuery.MessageArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method	Description
ConstraintReificationShapeQuery	addFragmentReference(Fragment<ConstraintReificationShapeQuery> fragment)	Adds a ConstraintReificationShapeQuery fragment reference at the current position of the query.
static Fragment<ConstraintReificationShapeQuery>	createFragment(String name, ConstraintReificationShapeQueryDefinition queryDef)	Creates a GraphQL "named" fragment with the specified query type definition.
ConstraintReificationShapeQuery	label()	A human-readable display label.
ConstraintReificationShapeQuery	message(ConstraintReificationShapeQuery.MessageArgumentsDefinition argsDef, LiteralQueryDefinition queryDef)	A human-readable message (possibly with placeholders for variables) explaining the cause of the result.
ConstraintReificationShapeQuery	message(LiteralQueryDefinition queryDef)	A human-readable message (possibly with placeholders for variables) explaining the cause of the result.
ConstraintReificationShapeQuery	Results(_ValidationResultQueryDefinition queryDef)	The (validation) results for the surrounding object, e.g.
ConstraintReificationShapeQuery	severity(_ResourceQueryDefinition queryDef)	Defines the severity that validation results produced by a shape must have.
ConstraintReificationShapeQuery	type(_ResourceQueryDefinition queryDef)	The types of this ConstraintReificationShape
ConstraintReificationShapeQuery	uri()	The URI of the resource.

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

Results

public ConstraintReificationShapeQuery Results(_ValidationResultQueryDefinition queryDef)

The (validation) results for the surrounding object, e.g. current constraint violations.

label

public ConstraintReificationShapeQuery label()

A human-readable display label.

message

public ConstraintReificationShapeQuery message(LiteralQueryDefinition queryDef)

A human-readable message (possibly with placeholders for variables) explaining the cause of the result.

message

public ConstraintReificationShapeQuery message(ConstraintReificationShapeQuery.MessageArgumentsDefinition argsDef,
                                               LiteralQueryDefinition queryDef)

A human-readable message (possibly with placeholders for variables) explaining the cause of the result.

severity

public ConstraintReificationShapeQuery severity(_ResourceQueryDefinition queryDef)

Defines the severity that validation results produced by a shape must have. Defaults to sh:Violation.

type

public ConstraintReificationShapeQuery type(_ResourceQueryDefinition queryDef)

The types of this ConstraintReificationShape

uri

public ConstraintReificationShapeQuery uri()

The URI of the resource.

createFragment

public static Fragment<ConstraintReificationShapeQuery> createFragment(String name,
                                                                       ConstraintReificationShapeQueryDefinition 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 ConstraintReificationShapeQuery addFragmentReference(Fragment<ConstraintReificationShapeQuery> fragment)

Adds a ConstraintReificationShapeQuery 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.