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

Class WorkflowGraphQuery

java.lang.Object

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

org.topbraidlive.client.java.graphql.platform.WorkflowGraphQuery

public class WorkflowGraphQuery
extends AbstractQuery<WorkflowGraphQuery>

A graph managed by a TopBraid workflow and working copy that is based on a master graph but may contain additional changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WorkflowGraphQuery.CreationTimeStampArguments
static interface	WorkflowGraphQuery.CreationTimeStampArgumentsDefinition
class	WorkflowGraphQuery.CreatorArguments
static interface	WorkflowGraphQuery.CreatorArgumentsDefinition
class	WorkflowGraphQuery.DescriptionArguments
static interface	WorkflowGraphQuery.DescriptionArgumentsDefinition
class	WorkflowGraphQuery.IdArguments
static interface	WorkflowGraphQuery.IdArgumentsDefinition
class	WorkflowGraphQuery.MasterGraphArguments
static interface	WorkflowGraphQuery.MasterGraphArgumentsDefinition

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
WorkflowGraphQuery	addFragmentReference(Fragment<WorkflowGraphQuery> fragment)	Adds a WorkflowGraphQuery fragment reference at the current position of the query.
static Fragment<WorkflowGraphQuery>	createFragment(String name, WorkflowGraphQueryDefinition queryDef)	Creates a GraphQL "named" fragment with the specified query type definition.
WorkflowGraphQuery	creationTimeStamp()	The time stamp that this graph was created (if known).
WorkflowGraphQuery	creationTimeStamp(WorkflowGraphQuery.CreationTimeStampArgumentsDefinition argsDef)	The time stamp that this graph was created (if known).
WorkflowGraphQuery	creator(UserQueryDefinition queryDef)	The user who created this graph (if known).
WorkflowGraphQuery	creator(WorkflowGraphQuery.CreatorArgumentsDefinition argsDef, UserQueryDefinition queryDef)	The user who created this graph (if known).
WorkflowGraphQuery	description()	A human-readable description of the graph (in the user's preferred language).
WorkflowGraphQuery	description(WorkflowGraphQuery.DescriptionArgumentsDefinition argsDef)	A human-readable description of the graph (in the user's preferred language).
WorkflowGraphQuery	id()	The id of the working copy.
WorkflowGraphQuery	id(WorkflowGraphQuery.IdArgumentsDefinition argsDef)	The id of the working copy.
WorkflowGraphQuery	label()	A human-readable display label.
WorkflowGraphQuery	masterGraph(MasterGraphQueryDefinition queryDef)	The master graph that this is based on.
WorkflowGraphQuery	masterGraph(WorkflowGraphQuery.MasterGraphArgumentsDefinition argsDef, MasterGraphQueryDefinition queryDef)	The master graph that this is based on.
WorkflowGraphQuery	Results(_ValidationResultQueryDefinition queryDef)	The (validation) results for the surrounding object, e.g.
WorkflowGraphQuery	type(_ResourceQueryDefinition queryDef)	The types of this WorkflowGraph
WorkflowGraphQuery	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 WorkflowGraphQuery Results(_ValidationResultQueryDefinition queryDef)

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

creationTimeStamp

public WorkflowGraphQuery creationTimeStamp()

The time stamp that this graph was created (if known).

creationTimeStamp

public WorkflowGraphQuery creationTimeStamp(WorkflowGraphQuery.CreationTimeStampArgumentsDefinition argsDef)

The time stamp that this graph was created (if known).

creator

public WorkflowGraphQuery creator(UserQueryDefinition queryDef)

The user who created this graph (if known).

creator

public WorkflowGraphQuery creator(WorkflowGraphQuery.CreatorArgumentsDefinition argsDef,
                                  UserQueryDefinition queryDef)

The user who created this graph (if known).

description

public WorkflowGraphQuery description()

A human-readable description of the graph (in the user's preferred language).

description

public WorkflowGraphQuery description(WorkflowGraphQuery.DescriptionArgumentsDefinition argsDef)

A human-readable description of the graph (in the user's preferred language).

id

public WorkflowGraphQuery id()

The id of the working copy.

id

public WorkflowGraphQuery id(WorkflowGraphQuery.IdArgumentsDefinition argsDef)

The id of the working copy.

label

public WorkflowGraphQuery label()

A human-readable display label.

masterGraph

public WorkflowGraphQuery masterGraph(MasterGraphQueryDefinition queryDef)

The master graph that this is based on.

masterGraph

public WorkflowGraphQuery masterGraph(WorkflowGraphQuery.MasterGraphArgumentsDefinition argsDef,
                                      MasterGraphQueryDefinition queryDef)

The master graph that this is based on.

type

public WorkflowGraphQuery type(_ResourceQueryDefinition queryDef)

The types of this WorkflowGraph

uri

public WorkflowGraphQuery uri()

The URI of the resource.

createFragment

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

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