Package com.commercetools.api.models.graph_ql

Interface GraphQLResponse

public interface GraphQLResponse

error is present in the response only if the GraphQL query was unsuccessful.

Example to create an instance using the builder pattern 

     GraphQLResponse graphQLResponse = GraphQLResponse.builder()
             .build()

  • Method Details

    • getData

      Object getData()

      JSON object that contains the results of a GraphQL query.

      Returns:
      data

    • getErrors

      @Valid @Valid List<GraphQLError> getErrors()

      Errors that the GraphQL query returns.

      Returns:
      errors

    • setData

      void setData(Object data)

      JSON object that contains the results of a GraphQL query.

      Parameters:
      data - value to be set

    • setErrors

      void setErrors(GraphQLError... errors)

      Errors that the GraphQL query returns.

      Parameters:
      errors - values to be set

    • setErrors

      void setErrors(List<GraphQLError> errors)

      Errors that the GraphQL query returns.

      Parameters:
      errors - values to be set

    • of

      static GraphQLResponse of()
      factory method
      Returns:
      instance of GraphQLResponse

    • of

      static GraphQLResponse of(GraphQLResponse template)
      factory method to create a shallow copy GraphQLResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      GraphQLResponse copyDeep()

    • deepCopy

      @Nullable static GraphQLResponse deepCopy(@Nullable GraphQLResponse template)
      factory method to create a deep copy of GraphQLResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static GraphQLResponseBuilder builder()
      builder factory method for GraphQLResponse
      Returns:
      builder

    • builder

      static GraphQLResponseBuilder builder(GraphQLResponse template)
      create builder for GraphQLResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withGraphQLResponse

      default <T> T withGraphQLResponse(Function<GraphQLResponse,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<GraphQLResponse> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference