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

Interface GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    GrpcEndpointBuilderFactory.GrpcEndpointBuilder
    Enclosing interface:
    GrpcEndpointBuilderFactory
    public static interface GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the gRPC component.

    • Method Detail

      • autoDiscoverClientInterceptors

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

      • bridgeErrorHandler

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • consumerStrategy

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder consumerStrategy​(GrpcEndpointBuilderFactory.GrpcConsumerStrategy consumerStrategy)
        This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender. The option is a: <code>org.apache.camel.component.grpc.GrpcConsumerStrategy</code> type. Default: PROPAGATION Group: consumer
        Parameters:
        consumerStrategy - the value to set
        Returns:
        the dsl builder

      • consumerStrategy

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder consumerStrategy​(String consumerStrategy)
        This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender. The option will be converted to a <code>org.apache.camel.component.grpc.GrpcConsumerStrategy</code> type. Default: PROPAGATION Group: consumer
        Parameters:
        consumerStrategy - the value to set
        Returns:
        the dsl builder

      • forwardOnCompleted

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder forwardOnCompleted​(boolean forwardOnCompleted)
        Determines if onCompleted events should be pushed to the Camel route. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        forwardOnCompleted - the value to set
        Returns:
        the dsl builder

      • forwardOnCompleted

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder forwardOnCompleted​(String forwardOnCompleted)
        Determines if onCompleted events should be pushed to the Camel route. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        forwardOnCompleted - the value to set
        Returns:
        the dsl builder

      • forwardOnError

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder forwardOnError​(boolean forwardOnError)
        Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        forwardOnError - the value to set
        Returns:
        the dsl builder

      • forwardOnError

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder forwardOnError​(String forwardOnError)
        Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        forwardOnError - the value to set
        Returns:
        the dsl builder

      • maxConcurrentCallsPerConnection

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConcurrentCallsPerConnection​(int maxConcurrentCallsPerConnection)
        The maximum number of concurrent calls permitted for each incoming server connection. The option is a: <code>int</code> type. Default: 2147483647 Group: consumer
        Parameters:
        maxConcurrentCallsPerConnection - the value to set
        Returns:
        the dsl builder

      • maxConcurrentCallsPerConnection

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConcurrentCallsPerConnection​(String maxConcurrentCallsPerConnection)
        The maximum number of concurrent calls permitted for each incoming server connection. The option will be converted to a <code>int</code> type. Default: 2147483647 Group: consumer
        Parameters:
        maxConcurrentCallsPerConnection - the value to set
        Returns:
        the dsl builder

      • routeControlledStreamObserver

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder routeControlledStreamObserver​(boolean routeControlledStreamObserver)
        Lets the route to take control over stream observer. If this value is set to true, then the response observer of gRPC call will be set with the name GrpcConstants.GRPC_RESPONSE_OBSERVER in the Exchange object. Please note that the stream observer's onNext(), onError(), onCompleted() methods should be called in the route. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        routeControlledStreamObserver - the value to set
        Returns:
        the dsl builder

      • routeControlledStreamObserver

        default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder routeControlledStreamObserver​(String routeControlledStreamObserver)
        Lets the route to take control over stream observer. If this value is set to true, then the response observer of gRPC call will be set with the name GrpcConstants.GRPC_RESPONSE_OBSERVER in the Exchange object. Please note that the stream observer's onNext(), onError(), onCompleted() methods should be called in the route. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        routeControlledStreamObserver - the value to set
        Returns:
        the dsl builder

      • authenticationType

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