Class MutationExecutorForum

java.lang.Object
org.forum.client.MutationExecutorForum
All Implemented Interfaces:
GraphQLMutationExecutor
Direct Known Subclasses:
Mutation

@Component public class MutationExecutorForum extends Object implements 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:
  • 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
You'll find all the documentation on the client page doc.
Author:
generated by graphql-java-generator
  • Constructor Details

    • MutationExecutorForum

      public MutationExecutorForum()
  • Method Details

    • execWithBindValues

      public MutationResponse execWithBindValues(String queryResponseDef, Map<String,Object> parameters) 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: 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 empty Map. 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 a Date for the GraphQLScalarTypeDate). 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 the ObjectResponse
      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 MutationResponse 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 the ObjectResponse
      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 MutationResponse execWithBindValues(ObjectResponse objectResponse, Map<String,Object> parameters) 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getGraphQLRequest(java.lang.String) method or one of the getXxxxGraphQLRequest(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 empty Map
      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 MutationResponse 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getGraphQLRequest(java.lang.String) method or one of the getXxxxGraphQLRequest(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

      public Builder getResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for a full request, as expected by the exec and execWithBindValues methods.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getGraphQLRequest

      public GraphQLRequestForum getGraphQLRequest(String fullRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum for full request. For instance:
       GraphQLRequestForum 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, 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 the createBoard 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 schema
      publiclyAvailable - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 the createBoard 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 schema
      publiclyAvailable - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateBoardGraphQLRequest(java.lang.String) method.
      name - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      publiclyAvailable - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateBoardGraphQLRequest(java.lang.String) method.
      name - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      publiclyAvailable - Parameter for the createBoard field of Mutation, as defined in the GraphQL schema
      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
    • getCreateBoardResponseBuilder

      public Builder getCreateBoardResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Board, as expected by the createBoard query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreateBoardGraphQLRequest

      public GraphQLRequestForum getCreateBoardGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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, 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 the createTopic 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 the createTopic 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateTopicGraphQLRequest(java.lang.String) method.
      topic - Parameter for the createTopic field of Mutation, as defined in the GraphQL schema
      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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateTopicGraphQLRequest(java.lang.String) method.
      topic - Parameter for the createTopic field of Mutation, as defined in the GraphQL schema
      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
    • getCreateTopicResponseBuilder

      public Builder getCreateTopicResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Topic, as expected by the createTopic query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreateTopicGraphQLRequest

      public GraphQLRequestForum getCreateTopicGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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, 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 the createPost 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 the createPost 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreatePostGraphQLRequest(java.lang.String) method.
      post - Parameter for the createPost field of Mutation, as defined in the GraphQL schema
      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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreatePostGraphQLRequest(java.lang.String) method.
      post - Parameter for the createPost field of Mutation, as defined in the GraphQL schema
      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
    • getCreatePostResponseBuilder

      public Builder getCreatePostResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Post, as expected by the createPost query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreatePostGraphQLRequest

      public GraphQLRequestForum getCreatePostGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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, 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 the createPosts 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 the createPosts 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreatePostsGraphQLRequest(java.lang.String) method.
      spam - Parameter for the createPosts field of Mutation, as defined in the GraphQL schema
      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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreatePostsGraphQLRequest(java.lang.String) method.
      spam - Parameter for the createPosts field of Mutation, as defined in the GraphQL schema
      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
    • getCreatePostsResponseBuilder

      public Builder getCreatePostsResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Post, as expected by the createPosts query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreatePostsGraphQLRequest

      public GraphQLRequestForum getCreatePostsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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, 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 the createMember 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 the createMember 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 schema
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateMemberGraphQLRequest(java.lang.String) method.
      input - Parameter for the createMember field of Mutation, as defined in the GraphQL schema
      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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the getCreateMemberGraphQLRequest(java.lang.String) method.
      input - Parameter for the createMember field of Mutation, as defined in the GraphQL schema
      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
    • getCreateMemberResponseBuilder

      public Builder getCreateMemberResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Member, as expected by the createMember query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreateMemberGraphQLRequest

      public GraphQLRequestForum getCreateMemberGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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, 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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 empty Map
      Throws:
      GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse
      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 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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the get__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 empty Map
      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: the ObjectResponse type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by the get__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

      public Builder get__typenameResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the String, as expected by the __typename query.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • get__typenameGraphQLRequest

      public GraphQLRequestForum get__typenameGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLRequestForum 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