Class MutationExecutor
java.lang.Object
com.graphql_java_generator.samples.forum.client.graphql.forum.client.util.MutationExecutor
- All Implemented Interfaces:
GraphQLMutationExecutor
This class contains the methods that allows the execution of the queries or mutations that are defined in the Mutation of the GraphQL schema.
These methods allows:
These methods allows:
- Preparation of full requests
- Execution of prepared full requests
- Execution of direct full direct requests
- Preparation of partial requests
- Execution of prepared partial requests
- Execution of direct partial requests
- Author:
- generated by graphql-java-generator
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription__typename
(ObjectResponse objectResponse, Object... paramsAndValues) This method is expected by the graphql-java framework.__typename
(String queryResponseDef, Object... paramsAndValues) This method executes a partial query on the __typename mutation against the GraphQL server.__typenameWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method is expected by the graphql-java framework.__typenameWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method executes a partial query on the __typename mutation against the GraphQL server.createBoard
(ObjectResponse objectResponse, String name, Boolean publiclyAvailable, Object... paramsAndValues) This method is expected by the graphql-java framework.createBoard
(String queryResponseDef, String name, Boolean publiclyAvailable, Object... paramsAndValues) This method executes a partial query on the createBoard mutation against the GraphQL server.createBoardWithBindValues
(ObjectResponse objectResponse, String name, Boolean publiclyAvailable, Map<String, Object> parameters) This method is expected by the graphql-java framework.createBoardWithBindValues
(String queryResponseDef, String name, Boolean publiclyAvailable, Map<String, Object> parameters) This method executes a partial query on the createBoard mutation against the GraphQL server.createMember
(ObjectResponse objectResponse, MemberInput input, Object... paramsAndValues) This method is expected by the graphql-java framework.createMember
(String queryResponseDef, MemberInput input, Object... paramsAndValues) This method executes a partial query on the createMember mutation against the GraphQL server.createMemberWithBindValues
(ObjectResponse objectResponse, MemberInput input, Map<String, Object> parameters) This method is expected by the graphql-java framework.createMemberWithBindValues
(String queryResponseDef, MemberInput input, Map<String, Object> parameters) This method executes a partial query on the createMember mutation against the GraphQL server.createPost
(ObjectResponse objectResponse, PostInput post, Object... paramsAndValues) This method is expected by the graphql-java framework.createPost
(String queryResponseDef, PostInput post, Object... paramsAndValues) This method executes a partial query on the createPost mutation against the GraphQL server.createPosts
(ObjectResponse objectResponse, List<PostInput> spam, Object... paramsAndValues) This method is expected by the graphql-java framework.createPosts
(String queryResponseDef, List<PostInput> spam, Object... paramsAndValues) This method executes a partial query on the createPosts mutation against the GraphQL server.createPostsWithBindValues
(ObjectResponse objectResponse, List<PostInput> spam, Map<String, Object> parameters) This method is expected by the graphql-java framework.createPostsWithBindValues
(String queryResponseDef, List<PostInput> spam, Map<String, Object> parameters) This method executes a partial query on the createPosts mutation against the GraphQL server.createPostWithBindValues
(ObjectResponse objectResponse, PostInput post, Map<String, Object> parameters) This method is expected by the graphql-java framework.This method executes a partial query on the createPost mutation against the GraphQL server.createTopic
(ObjectResponse objectResponse, TopicInput topic, Object... paramsAndValues) This method is expected by the graphql-java framework.createTopic
(String queryResponseDef, TopicInput topic, Object... paramsAndValues) This method executes a partial query on the createTopic mutation against the GraphQL server.createTopicWithBindValues
(ObjectResponse objectResponse, TopicInput topic, Map<String, Object> parameters) This method is expected by the graphql-java framework.createTopicWithBindValues
(String queryResponseDef, TopicInput topic, Map<String, Object> parameters) This method executes a partial query on the createTopic mutation against the GraphQL server.exec
(ObjectResponse objectResponse, Object... paramsAndValues) This method takes a full request definition, and executes it against the GraphQL server.This method takes a full request definition, and executes it against the GraphQL server.execWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method takes a full request definition, and executes it against the GraphQL server.execWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method takes a full request definition, and executes it against the GraphQL server.get__typenameGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the __typename EXECUTOR, created with the given Partial request.Get theBuilder
for the String, as expected by the __typename query.getCreateBoardGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the createBoard EXECUTOR, created with the given Partial request.Get theBuilder
for the Board, as expected by the createBoard query.getCreateMemberGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the createMember EXECUTOR, created with the given Partial request.Get theBuilder
for the Member, as expected by the createMember query.getCreatePostGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the createPost EXECUTOR, created with the given Partial request.Get theBuilder
for the Post, as expected by the createPost query.getCreatePostsGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the createPosts EXECUTOR, created with the given Partial request.Get theBuilder
for the Post, as expected by the createPosts query.getCreateTopicGraphQLRequest
(String partialRequest) Get theGraphQLRequest
for the createTopic EXECUTOR, created with the given Partial request.Get theBuilder
for the Topic, as expected by the createTopic query.getGraphQLRequest
(String fullRequest) Get theGraphQLRequest
for full request.Get theBuilder
for a full request, as expected by the exec and execWithBindValues methods.
-
Constructor Details
-
MutationExecutor
public MutationExecutor()
-
-
Method Details
-
execWithBindValues
public Mutation execWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method takes a full request definition, and executes it against the GraphQL server. As this class is a mutation executor, the provided request must be a mutation full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it: This method takes a full request definition, and executes it against the GraphQL server. That is, the query contains the full string that follows the mutation keyword.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the mutation, in the native GraphQL format (see here above). It must omit the mutation keyword, and start by the first { that follows. It may contain directives, as explained in the GraphQL specs.parameters
- The map of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
. The key is the parameter name, as declared in the request you defined (in the above sample: param is an optional parameter and skip is a mandatory one). The value is the parameter value in its Java type (for instance aDate
for theGraphQLScalarTypeDate
). The parameters which value is missing in this map will be ignored.- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
exec
public Mutation exec(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method takes a full request definition, and executes it against the GraphQL server. As this class is a mutation executor, the provided request must be a mutation full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above). It must omit the mutation keyword, and start by the first { that follows. It may contain directives, as explained in the GraphQL specs.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
execWithBindValues
public Mutation execWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method takes a full request definition, and executes it against the GraphQL server. As this class is a mutation executor, the provided request must be a mutation full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetGraphQLRequest(java.lang.String)
method or one of thegetXxxxGraphQLRequest(String)
methods.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
exec
public Mutation exec(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method takes a full request definition, and executes it against the GraphQL server. As this class is a mutation executor, the provided request must be a mutation full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetGraphQLRequest(java.lang.String)
method or one of thegetXxxxGraphQLRequest(String)
paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getResponseBuilder
Get theBuilder
for a full request, as expected by the exec and execWithBindValues methods.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getGraphQLRequest
public GraphQLRequest getGraphQLRequest(String fullRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for full request. For instance:GraphQLRequest request = new GraphQLRequest(fullRequest);
- Parameters:
fullRequest
- The full GraphQL Request, as specified in the GraphQL specification- Returns:
- Throws:
GraphQLRequestPreparationException
-
createBoardWithBindValues
public Board createBoardWithBindValues(String queryResponseDef, String name, Boolean publiclyAvailable, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the createBoard mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateBoard
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)name
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemapubliclyAvailable
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createBoard
public Board createBoard(String queryResponseDef, String name, Boolean publiclyAvailable, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the createBoard mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateBoard
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)name
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemapubliclyAvailable
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createBoardWithBindValues
public Board createBoardWithBindValues(ObjectResponse objectResponse, String name, Boolean publiclyAvailable, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateBoardGraphQLRequest(java.lang.String)
method.name
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemapubliclyAvailable
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createBoard
public Board createBoard(ObjectResponse objectResponse, String name, Boolean publiclyAvailable, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateBoardGraphQLRequest(java.lang.String)
method.name
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemapubliclyAvailable
- Parameter for the createBoard field of Mutation, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getCreateBoardResponseBuilder
Get theBuilder
for the Board, as expected by the createBoard query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getCreateBoardGraphQLRequest
public GraphQLRequest getCreateBoardGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the createBoard EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
createTopicWithBindValues
public Topic createTopicWithBindValues(String queryResponseDef, TopicInput topic, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the createTopic mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateTopic
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)topic
- Parameter for the createTopic field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createTopic
public Topic createTopic(String queryResponseDef, TopicInput topic, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the createTopic mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateTopic
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)topic
- Parameter for the createTopic field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createTopicWithBindValues
public Topic createTopicWithBindValues(ObjectResponse objectResponse, TopicInput topic, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateTopicGraphQLRequest(java.lang.String)
method.topic
- Parameter for the createTopic field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createTopic
public Topic createTopic(ObjectResponse objectResponse, TopicInput topic, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateTopicGraphQLRequest(java.lang.String)
method.topic
- Parameter for the createTopic field of Mutation, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getCreateTopicResponseBuilder
Get theBuilder
for the Topic, as expected by the createTopic query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getCreateTopicGraphQLRequest
public GraphQLRequest getCreateTopicGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the createTopic EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
createPostWithBindValues
public Post createPostWithBindValues(String queryResponseDef, PostInput post, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the createPost mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreatePost
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)post
- Parameter for the createPost field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPost
public Post createPost(String queryResponseDef, PostInput post, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the createPost mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreatePost
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)post
- Parameter for the createPost field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPostWithBindValues
public Post createPostWithBindValues(ObjectResponse objectResponse, PostInput post, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreatePostGraphQLRequest(java.lang.String)
method.post
- Parameter for the createPost field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPost
public Post createPost(ObjectResponse objectResponse, PostInput post, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreatePostGraphQLRequest(java.lang.String)
method.post
- Parameter for the createPost field of Mutation, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getCreatePostResponseBuilder
Get theBuilder
for the Post, as expected by the createPost query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getCreatePostGraphQLRequest
public GraphQLRequest getCreatePostGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the createPost EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
createPostsWithBindValues
public List<Post> createPostsWithBindValues(String queryResponseDef, List<PostInput> spam, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the createPosts mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreatePosts
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)spam
- Parameter for the createPosts field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPosts
public List<Post> createPosts(String queryResponseDef, List<PostInput> spam, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the createPosts mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreatePosts
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)spam
- Parameter for the createPosts field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPostsWithBindValues
public List<Post> createPostsWithBindValues(ObjectResponse objectResponse, List<PostInput> spam, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreatePostsGraphQLRequest(java.lang.String)
method.spam
- Parameter for the createPosts field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createPosts
public List<Post> createPosts(ObjectResponse objectResponse, List<PostInput> spam, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreatePostsGraphQLRequest(java.lang.String)
method.spam
- Parameter for the createPosts field of Mutation, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getCreatePostsResponseBuilder
Get theBuilder
for the Post, as expected by the createPosts query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getCreatePostsGraphQLRequest
public GraphQLRequest getCreatePostsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the createPosts EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
createMemberWithBindValues
public Member createMemberWithBindValues(String queryResponseDef, MemberInput input, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the createMember mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateMember
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)input
- Parameter for the createMember field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createMember
public Member createMember(String queryResponseDef, MemberInput input, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the createMember mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thecreateMember
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)input
- Parameter for the createMember field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createMemberWithBindValues
public Member createMemberWithBindValues(ObjectResponse objectResponse, MemberInput input, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateMemberGraphQLRequest(java.lang.String)
method.input
- Parameter for the createMember field of Mutation, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
createMember
public Member createMember(ObjectResponse objectResponse, MemberInput input, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by thegetCreateMemberGraphQLRequest(java.lang.String)
method.input
- Parameter for the createMember field of Mutation, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getCreateMemberResponseBuilder
Get theBuilder
for the Member, as expected by the createMember query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getCreateMemberGraphQLRequest
public GraphQLRequest getCreateMemberGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the createMember EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
__typenameWithBindValues
public String __typenameWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the __typename mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__typename
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typename
public String __typename(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the __typename mutation against the GraphQL server. That is, the mutation is one of the field of the Mutation type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__typename
of the Mutation mutation type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typenameWithBindValues
public String __typenameWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by theget__typenameGraphQLRequest(java.lang.String)
method.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typename
public String __typename(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequest POJO, as returned by theget__typenameGraphQLRequest(java.lang.String)
method.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
get__typenameResponseBuilder
Get theBuilder
for the String, as expected by the __typename query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
get__typenameGraphQLRequest
public GraphQLRequest get__typenameGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequest
for the __typename EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-