Class MutationTypeReactiveExecutor

java.lang.Object
com.generated.graphql.util.MutationTypeReactiveExecutor
All Implemented Interfaces:
GraphQLMutationReactiveExecutor

@Component public class MutationTypeReactiveExecutor extends Object implements GraphQLMutationReactiveExecutor
This class contains the methods that allows the execution of the queries or mutations that are defined in the MutationType of the GraphQL schema. All the methods for this executor are in spring reactive, that is: they return a Mono.
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

    • MutationTypeReactiveExecutor

      public MutationTypeReactiveExecutor()
  • Method Details

    • execWithBindValues

      public reactor.core.publisher.Mono<MutationType> 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 request will be executed in reactive mode, that is: it returns a Mono<com.generated.graphql.MutationType>
      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 mutation, in the native GraphQL format (see here above). It must ommit the query/mutation/subscription 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 defined in the query. 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 defined in the query (in the above sample: heroParam is an optional parameter and skip is a mandatory one). The value is the parameter vale in its Java type (for instance a Date for the GraphQLScalarTypeDate). The parameters which value is missing in this map will no be transmitted toward the GraphQL server.
      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 reactor.core.publisher.Mono<MutationType> 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 request will be executed in reactive mode, that is: it returns a Mono<com.generated.graphql.MutationType>
      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 ommit the query/mutation/subscription 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 reactor.core.publisher.Mono<MutationType> 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 request will be executed in reactive mode, that is: it returns a Mono<com.generated.graphql.MutationType>
      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 GraphQLRequest 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 defined in the query. 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 reactor.core.publisher.Mono<MutationType> 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 request will be executed in reactive mode, that is: it returns a Mono<com.generated.graphql.MutationType>
      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 GraphQLRequest POJO, as returned by the getGraphQLRequest(java.lang.String) method or one of the getXxxxGraphQLRequest(String) methods.
      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 GraphQLReactiveRequest getGraphQLRequest(String fullRequest) throws GraphQLRequestPreparationException
      Get the GraphQLReactiveRequest for full request. For instance:
       GraphQLReactiveRequest request = new GraphQLRequest(fullRequest);
       
      Parameters:
      fullRequest - The full GraphQL Request, as specified in the GraphQL specification
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • createHumanWithBindValues

      public reactor.core.publisher.Mono<Optional<Human>> createHumanWithBindValues(String queryResponseDef, String name, String homePlanet, Map<String,Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      Parameters:
      queryResponseDef - The response definition of the query, in the native GraphQL format (see here above)
      name - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      homePlanet - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • createHuman

      public reactor.core.publisher.Mono<Optional<Human>> createHuman(String queryResponseDef, String name, String homePlanet, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      Parameters:
      queryResponseDef - The response definition of the query/mutation, in the native GraphQL format (see here above)
      name - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      homePlanet - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • createHumanWithBindValues

      public reactor.core.publisher.Mono<Optional<Human>> createHumanWithBindValues(ObjectResponse objectResponse, String name, String homePlanet, 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 GraphQLRequest POJO, as returned by the getCreateHumanGraphQLRequest(java.lang.String) method.
      name - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      homePlanet - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • createHuman

      public reactor.core.publisher.Mono<Optional<Human>> createHuman(ObjectResponse objectResponse, String name, String homePlanet, 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 GraphQLRequest POJO, as returned by the getCreateHumanGraphQLRequest(java.lang.String) method.
      name - Parameter for the createHuman field of MutationType, as defined in the GraphQL schema
      homePlanet - Parameter for the createHuman field of MutationType, 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
    • getCreateHumanResponseBuilder

      public Builder getCreateHumanResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Human, as expected by the createHuman query/mutation.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getCreateHumanGraphQLRequest

      public GraphQLReactiveRequest getCreateHumanGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLReactiveRequest for the createHuman REACTIVE_EXECUTOR, created with the given Partial request.
      Parameters:
      partialRequest - The Partial GraphQL request, as explained in the plugin client documentation
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • addFriendWithBindValues

      public reactor.core.publisher.Mono<Optional<Character>> addFriendWithBindValues(String queryResponseDef, String idCharacter, String idNewFriend, Map<String,Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      Parameters:
      queryResponseDef - The response definition of the query, in the native GraphQL format (see here above)
      idCharacter - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      idNewFriend - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • addFriend

      public reactor.core.publisher.Mono<Optional<Character>> addFriend(String queryResponseDef, String idCharacter, String idNewFriend, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      Parameters:
      queryResponseDef - The response definition of the query/mutation, in the native GraphQL format (see here above)
      idCharacter - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      idNewFriend - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • addFriendWithBindValues

      public reactor.core.publisher.Mono<Optional<Character>> addFriendWithBindValues(ObjectResponse objectResponse, String idCharacter, String idNewFriend, 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 GraphQLRequest POJO, as returned by the getAddFriendGraphQLRequest(java.lang.String) method.
      idCharacter - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      idNewFriend - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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
    • addFriend

      public reactor.core.publisher.Mono<Optional<Character>> addFriend(ObjectResponse objectResponse, String idCharacter, String idNewFriend, 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 GraphQLRequest POJO, as returned by the getAddFriendGraphQLRequest(java.lang.String) method.
      idCharacter - Parameter for the addFriend field of MutationType, as defined in the GraphQL schema
      idNewFriend - Parameter for the addFriend field of MutationType, 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
    • getAddFriendResponseBuilder

      public Builder getAddFriendResponseBuilder() throws GraphQLRequestPreparationException
      Get the Builder for the Character, as expected by the addFriend query/mutation.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • getAddFriendGraphQLRequest

      public GraphQLReactiveRequest getAddFriendGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLReactiveRequest for the addFriend REACTIVE_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 reactor.core.publisher.Mono<Optional<String>> __typenameWithBindValues(String queryResponseDef, Map<String,Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      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 defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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 reactor.core.publisher.Mono<Optional<String>> __typename(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException
      This method executes a partial query against the GraphQL server. That is, the query that is one of the queries defined in the GraphQL query object. The queryResponseDef contains the part of the query that is after the query name.
      For instance, if the query hero has one parameter (as defined in the GraphQL schema):
      Parameters:
      queryResponseDef - The response definition of the query/mutation, in the native GraphQL format (see here above)
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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 reactor.core.publisher.Mono<Optional<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 GraphQLRequest POJO, as returned by the get__typenameGraphQLRequest(java.lang.String) method.
      parameters - The list of values, for the bind variables defined in the query/mutation. If there is no bind variable in the defined query/mutation, 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 reactor.core.publisher.Mono<Optional<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 GraphQLRequest 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/mutation.
      Returns:
      Throws:
      GraphQLRequestPreparationException
    • get__typenameGraphQLRequest

      public GraphQLReactiveRequest get__typenameGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException
      Get the GraphQLReactiveRequest for the __typename REACTIVE_EXECUTOR, created with the given Partial request.
      Parameters:
      partialRequest - The Partial GraphQL request, as explained in the plugin client documentation
      Returns:
      Throws:
      GraphQLRequestPreparationException