Package org.apache.camel.builder.endpoint.dsl

Interface GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
GraphqlEndpointBuilderFactory
public static interface GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the GraphQL component.

  • Method Details

    • advanced

      default GraphqlEndpointBuilderFactory.AdvancedGraphqlEndpointBuilder advanced()

    • operationName

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder operationName(String operationName)
      The query or mutation name. The option is a: java.lang.String type. Group: producer
      Parameters:
      operationName - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder proxyHost(String proxyHost)
      The proxy host in the format hostname:port. The option is a: java.lang.String type. Group: producer
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • query

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder query(String query)
      The query text. The option is a: java.lang.String type. Group: producer
      Parameters:
      query - the value to set
      Returns:
      the dsl builder

    • queryFile

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder queryFile(String queryFile)
      The query file name located in the classpath (or use file: to load from file system). The option is a: java.lang.String type. Group: producer
      Parameters:
      queryFile - the value to set
      Returns:
      the dsl builder

    • queryHeader

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder queryHeader(String queryHeader)
      The name of a header containing the GraphQL query. The option is a: java.lang.String type. Group: producer
      Parameters:
      queryHeader - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder throwExceptionOnFailure(boolean throwExceptionOnFailure)
      Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option is a: boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder throwExceptionOnFailure(String throwExceptionOnFailure)
      Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option will be converted to a boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • variables

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder variables(org.apache.camel.util.json.JsonObject variables)
      The JsonObject instance containing the operation variables. The option is a: org.apache.camel.util.json.JsonObject type. Group: producer
      Parameters:
      variables - the value to set
      Returns:
      the dsl builder

    • variables

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder variables(String variables)
      The JsonObject instance containing the operation variables. The option will be converted to a org.apache.camel.util.json.JsonObject type. Group: producer
      Parameters:
      variables - the value to set
      Returns:
      the dsl builder

    • variablesHeader

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder variablesHeader(String variablesHeader)
      The name of a header containing a JsonObject instance containing the operation variables. The option is a: java.lang.String type. Group: producer
      Parameters:
      variablesHeader - the value to set
      Returns:
      the dsl builder

    • accessToken

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder accessToken(String accessToken)
      The access token sent in the Authorization header. The option is a: java.lang.String type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • jwtAuthorizationType

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder jwtAuthorizationType(String jwtAuthorizationType)
      The JWT Authorization type. Default is Bearer. The option is a: java.lang.String type. Default: Bearer Group: security
      Parameters:
      jwtAuthorizationType - the value to set
      Returns:
      the dsl builder

    • password

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder password(String password)
      The password for Basic authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • username

      default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder username(String username)
      The username for Basic authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder