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

Interface GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    GrpcEndpointBuilderFactory.GrpcEndpointBuilder
    Enclosing interface:
    GrpcEndpointBuilderFactory
    public static interface GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the gRPC component.

    • Method Detail

      • autoDiscoverClientInterceptors

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder autoDiscoverClientInterceptors​(boolean autoDiscoverClientInterceptors)
        Setting the autoDiscoverClientInterceptors mechanism, if true, the component will look for a ClientInterceptor instance in the registry automatically otherwise it will skip that checking. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        autoDiscoverClientInterceptors - the value to set
        Returns:
        the dsl builder

      • autoDiscoverClientInterceptors

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder autoDiscoverClientInterceptors​(String autoDiscoverClientInterceptors)
        Setting the autoDiscoverClientInterceptors mechanism, if true, the component will look for a ClientInterceptor instance in the registry automatically otherwise it will skip that checking. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        autoDiscoverClientInterceptors - the value to set
        Returns:
        the dsl builder

      • flowControlWindow

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder flowControlWindow​(int flowControlWindow)
        The HTTP/2 flow control window size (MiB). The option is a: <code>int</code> type. Default: 1048576 Group: common
        Parameters:
        flowControlWindow - the value to set
        Returns:
        the dsl builder

      • flowControlWindow

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder flowControlWindow​(String flowControlWindow)
        The HTTP/2 flow control window size (MiB). The option will be converted to a <code>int</code> type. Default: 1048576 Group: common
        Parameters:
        flowControlWindow - the value to set
        Returns:
        the dsl builder

      • maxMessageSize

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder maxMessageSize​(int maxMessageSize)
        The maximum message size allowed to be received/sent (MiB). The option is a: <code>int</code> type. Default: 4194304 Group: common
        Parameters:
        maxMessageSize - the value to set
        Returns:
        the dsl builder

      • maxMessageSize

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder maxMessageSize​(String maxMessageSize)
        The maximum message size allowed to be received/sent (MiB). The option will be converted to a <code>int</code> type. Default: 4194304 Group: common
        Parameters:
        maxMessageSize - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder 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 GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder 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

      • producerStrategy

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder producerStrategy​(GrpcEndpointBuilderFactory.GrpcProducerStrategy producerStrategy)
        The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream'). The option is a: <code>org.apache.camel.component.grpc.GrpcProducerStrategy</code> type. Default: SIMPLE Group: producer
        Parameters:
        producerStrategy - the value to set
        Returns:
        the dsl builder

      • producerStrategy

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder producerStrategy​(String producerStrategy)
        The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream'). The option will be converted to a <code>org.apache.camel.component.grpc.GrpcProducerStrategy</code> type. Default: SIMPLE Group: producer
        Parameters:
        producerStrategy - the value to set
        Returns:
        the dsl builder

      • streamRepliesTo

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder streamRepliesTo​(String streamRepliesTo)
        When using STREAMING client mode, it indicates the endpoint where responses should be forwarded. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        streamRepliesTo - the value to set
        Returns:
        the dsl builder

      • authenticationType

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder authenticationType​(String authenticationType)
        Authentication method type in advance to the SSL/TLS negotiation. The option will be converted to a <code>org.apache.camel.component.grpc.GrpcAuthType</code> type. Default: NONE Group: security
        Parameters:
        authenticationType - the value to set
        Returns:
        the dsl builder

      • jwtAlgorithm

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder jwtAlgorithm​(String jwtAlgorithm)
        JSON Web Token sign algorithm. The option will be converted to a <code>org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm</code> type. Default: HMAC256 Group: security
        Parameters:
        jwtAlgorithm - the value to set
        Returns:
        the dsl builder

      • keyCertChainResource

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder keyCertChainResource​(String keyCertChainResource)
        The X.509 certificate chain file resource in PEM format link. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        keyCertChainResource - the value to set
        Returns:
        the dsl builder

      • keyResource

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder keyResource​(String keyResource)
        The PKCS#8 private key file resource in PEM format link. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        keyResource - the value to set
        Returns:
        the dsl builder

      • negotiationType

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder negotiationType​(String negotiationType)
        Identifies the security negotiation type used for HTTP/2 communication. The option will be converted to a <code>io.grpc.netty.NegotiationType</code> type. Default: PLAINTEXT Group: security
        Parameters:
        negotiationType - the value to set
        Returns:
        the dsl builder

      • serviceAccountResource

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder serviceAccountResource​(String serviceAccountResource)
        Service Account key file in JSON format resource link supported by the Google Cloud SDK. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        serviceAccountResource - the value to set
        Returns:
        the dsl builder

      • trustCertCollectionResource

        default GrpcEndpointBuilderFactory.GrpcEndpointProducerBuilder trustCertCollectionResource​(String trustCertCollectionResource)
        The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        trustCertCollectionResource - the value to set
        Returns:
        the dsl builder