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 Detail

      • lazyStartProducer

        default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - 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: <code>java.lang.String</code> type. Group: producer
        Parameters:
        queryHeader - the value to set
        Returns:
        the dsl builder

      • variables

        default GraphqlEndpointBuilderFactory.GraphqlEndpointBuilder variables​(Object variables)
        The JsonObject instance containing the operation variables. The option is a: <code>org.apache.camel.util.json.JsonObject</code> 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 <code>org.apache.camel.util.json.JsonObject</code> 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: <code>java.lang.String</code> 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: <code>java.lang.String</code> 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: <code>java.lang.String</code> type. Default: Bearer Group: security
        Parameters:
        jwtAuthorizationType - the value to set
        Returns:
        the dsl builder