Module com.graphql_java_generator.graphql_maven_plugin_project.graphql_java_client_runtime
Package com.graphql_java_generator.client.graphqlrepository

Annotation Interface PartialRequest

@Documented @Retention(RUNTIME) @Target(METHOD) public @interface PartialRequest
This annotation marks the method of an interface, as being a partial GraphQL request. See the Project Wiki request page for more information
Author:
etienne-sf

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    request
    The GraphQL request.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    requestName
    The name of the request, as defined in the GraphQL schema.
    RequestType
    requestType
    The kind of request that this method will execute.

  • Element Details

    • request

      String request
      The GraphQL request. It can be either a Partial Request or a Full Request.

    • requestType

      RequestType requestType
      The kind of request that this method will execute. One of QUERY, MUTATION, SUBSCRIPTION. This is not mandatory, and the default value is QUERY
      Default:
      query

    • requestName

      String requestName
      The name of the request, as defined in the GraphQL schema. It's the field name in the Query, Mutation or Subscription type.
      This name must be exactly the same as the one defined in the GraphQL schema. For instance, it's case sensitive.
      This field is optional: if no requestName value is given, then the method name must match exactly the request (query/mutation/subscription) field name that is defined in the GraphQL schema.
      Default:
      ""