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 Details

    • advanced

      default GrpcEndpointBuilderFactory.AdvancedGrpcEndpointConsumerBuilder advanced()

    • flowControlWindow

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder flowControlWindow(int flowControlWindow)
      The HTTP/2 flow control window size (MiB). The option is a: int 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 int 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: int 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 int type. Default: 4194304 Group: common
      Parameters:
      maxMessageSize - the value to set
      Returns:
      the dsl builder

    • autoDiscoverServerInterceptors

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder autoDiscoverServerInterceptors(boolean autoDiscoverServerInterceptors)
      Setting the autoDiscoverServerInterceptors mechanism, if true, the component will look for a ServerInterceptor instance in the registry automatically otherwise it will skip that checking. The option is a: boolean type. Default: true Group: consumer
      Parameters:
      autoDiscoverServerInterceptors - the value to set
      Returns:
      the dsl builder

    • autoDiscoverServerInterceptors

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder autoDiscoverServerInterceptors(String autoDiscoverServerInterceptors)
      Setting the autoDiscoverServerInterceptors mechanism, if true, the component will look for a ServerInterceptor instance in the registry automatically otherwise it will skip that checking. The option will be converted to a boolean type. Default: true Group: consumer
      Parameters:
      autoDiscoverServerInterceptors - the value to set
      Returns:
      the dsl builder

    • consumerStrategy

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder consumerStrategy(org.apache.camel.component.grpc.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. If a delegation strategy is selected, request is sent to the stream, but no response generated under the assumption that all necessary responses will be sent at another part of route. Delegation strategy always comes with routeControlledStreamObserver=true to be able to achieve the assumption. The option is a: org.apache.camel.component.grpc.GrpcConsumerStrategy 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. If a delegation strategy is selected, request is sent to the stream, but no response generated under the assumption that all necessary responses will be sent at another part of route. Delegation strategy always comes with routeControlledStreamObserver=true to be able to achieve the assumption. The option will be converted to a org.apache.camel.component.grpc.GrpcConsumerStrategy 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: boolean 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 boolean 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: boolean 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 boolean type. Default: false Group: consumer
      Parameters:
      forwardOnError - the value to set
      Returns:
      the dsl builder

    • initialFlowControlWindow

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder initialFlowControlWindow(int initialFlowControlWindow)
      Sets the initial flow control window in bytes. The option is a: int type. Default: 1048576 Group: consumer
      Parameters:
      initialFlowControlWindow - the value to set
      Returns:
      the dsl builder

    • initialFlowControlWindow

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder initialFlowControlWindow(String initialFlowControlWindow)
      Sets the initial flow control window in bytes. The option will be converted to a int type. Default: 1048576 Group: consumer
      Parameters:
      initialFlowControlWindow - the value to set
      Returns:
      the dsl builder

    • keepAliveTime

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder keepAliveTime(long keepAliveTime)
      Sets a custom keepalive time in milliseconds, the delay time for sending next keepalive ping. A value of Long.MAX_VALUE or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable keepalive. The option is a: long type. Default: 7200000 Group: consumer
      Parameters:
      keepAliveTime - the value to set
      Returns:
      the dsl builder

    • keepAliveTime

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder keepAliveTime(String keepAliveTime)
      Sets a custom keepalive time in milliseconds, the delay time for sending next keepalive ping. A value of Long.MAX_VALUE or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable keepalive. The option will be converted to a long type. Default: 7200000 Group: consumer
      Parameters:
      keepAliveTime - the value to set
      Returns:
      the dsl builder

    • keepAliveTimeout

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder keepAliveTimeout(long keepAliveTimeout)
      Sets a custom keepalive timeout in milliseconds, the timeout for keepalive ping requests. The option is a: long type. Default: 20000 Group: consumer
      Parameters:
      keepAliveTimeout - the value to set
      Returns:
      the dsl builder

    • keepAliveTimeout

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder keepAliveTimeout(String keepAliveTimeout)
      Sets a custom keepalive timeout in milliseconds, the timeout for keepalive ping requests. The option will be converted to a long type. Default: 20000 Group: consumer
      Parameters:
      keepAliveTimeout - 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. Defaults to no limit. The option is a: int 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. Defaults to no limit. The option will be converted to a int type. Default: 2147483647 Group: consumer
      Parameters:
      maxConcurrentCallsPerConnection - the value to set
      Returns:
      the dsl builder

    • maxConnectionAge

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionAge(long maxConnectionAge)
      Sets a custom max connection age in milliseconds. Connections lasting longer than which will be gracefully terminated. A random jitter of /-10% will be added to the value. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection age. The option is a: long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionAge - the value to set
      Returns:
      the dsl builder

    • maxConnectionAge

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionAge(String maxConnectionAge)
      Sets a custom max connection age in milliseconds. Connections lasting longer than which will be gracefully terminated. A random jitter of /-10% will be added to the value. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection age. The option will be converted to a long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionAge - the value to set
      Returns:
      the dsl builder

    • maxConnectionAgeGrace

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionAgeGrace(long maxConnectionAgeGrace)
      Sets a custom grace time in milliseconds for the graceful connection termination. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE is considered infinite. The option is a: long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionAgeGrace - the value to set
      Returns:
      the dsl builder

    • maxConnectionAgeGrace

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionAgeGrace(String maxConnectionAgeGrace)
      Sets a custom grace time in milliseconds for the graceful connection termination. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE is considered infinite. The option will be converted to a long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionAgeGrace - the value to set
      Returns:
      the dsl builder

    • maxConnectionIdle

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionIdle(long maxConnectionIdle)
      Sets a custom max connection idle time in milliseconds. Connection being idle for longer than which will be gracefully terminated. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection idle. The option is a: long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionIdle - the value to set
      Returns:
      the dsl builder

    • maxConnectionIdle

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxConnectionIdle(String maxConnectionIdle)
      Sets a custom max connection idle time in milliseconds. Connection being idle for longer than which will be gracefully terminated. A value of Long.MAX_VALUE (the default) or a value greater or equal to NettyServerBuilder.AS_LARGE_AS_INFINITE will disable max connection idle. The option will be converted to a long type. Default: 9223372036854775807 Group: consumer
      Parameters:
      maxConnectionIdle - the value to set
      Returns:
      the dsl builder

    • maxInboundMetadataSize

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxInboundMetadataSize(int maxInboundMetadataSize)
      Sets the maximum size of metadata allowed to be received. The default is 8 KiB. The option is a: int type. Default: 8192 Group: consumer
      Parameters:
      maxInboundMetadataSize - the value to set
      Returns:
      the dsl builder

    • maxInboundMetadataSize

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxInboundMetadataSize(String maxInboundMetadataSize)
      Sets the maximum size of metadata allowed to be received. The default is 8 KiB. The option will be converted to a int type. Default: 8192 Group: consumer
      Parameters:
      maxInboundMetadataSize - the value to set
      Returns:
      the dsl builder

    • maxRstFramesPerWindow

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxRstFramesPerWindow(int maxRstFramesPerWindow)
      Limits the rate of incoming RST_STREAM frames per connection to maxRstFramesPerWindow per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstPeriodSeconds for it to be effective. The option is a: int type. Default: 0 Group: consumer
      Parameters:
      maxRstFramesPerWindow - the value to set
      Returns:
      the dsl builder

    • maxRstFramesPerWindow

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxRstFramesPerWindow(String maxRstFramesPerWindow)
      Limits the rate of incoming RST_STREAM frames per connection to maxRstFramesPerWindow per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstPeriodSeconds for it to be effective. The option will be converted to a int type. Default: 0 Group: consumer
      Parameters:
      maxRstFramesPerWindow - the value to set
      Returns:
      the dsl builder

    • maxRstPeriodSeconds

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxRstPeriodSeconds(int maxRstPeriodSeconds)
      Limits the rate of incoming RST_STREAM frames per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstFramesPerWindow for it to be effective. The option is a: int type. Default: 0 Group: consumer
      Parameters:
      maxRstPeriodSeconds - the value to set
      Returns:
      the dsl builder

    • maxRstPeriodSeconds

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder maxRstPeriodSeconds(String maxRstPeriodSeconds)
      Limits the rate of incoming RST_STREAM frames per maxRstPeriodSeconds. This option MUST be used in conjunction with maxRstFramesPerWindow for it to be effective. The option will be converted to a int type. Default: 0 Group: consumer
      Parameters:
      maxRstPeriodSeconds - the value to set
      Returns:
      the dsl builder

    • permitKeepAliveTime

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder permitKeepAliveTime(long permitKeepAliveTime)
      Sets the most aggressive keep-alive time in milliseconds that clients are permitted to configure. The server will try to detect clients exceeding this rate and will forcefully close the connection. The option is a: long type. Default: 300000 Group: consumer
      Parameters:
      permitKeepAliveTime - the value to set
      Returns:
      the dsl builder

    • permitKeepAliveTime

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder permitKeepAliveTime(String permitKeepAliveTime)
      Sets the most aggressive keep-alive time in milliseconds that clients are permitted to configure. The server will try to detect clients exceeding this rate and will forcefully close the connection. The option will be converted to a long type. Default: 300000 Group: consumer
      Parameters:
      permitKeepAliveTime - the value to set
      Returns:
      the dsl builder

    • permitKeepAliveWithoutCalls

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder permitKeepAliveWithoutCalls(boolean permitKeepAliveWithoutCalls)
      Sets whether to allow clients to send keep-alive HTTP/ 2 PINGs even if there are no outstanding RPCs on the connection. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      permitKeepAliveWithoutCalls - the value to set
      Returns:
      the dsl builder

    • permitKeepAliveWithoutCalls

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder permitKeepAliveWithoutCalls(String permitKeepAliveWithoutCalls)
      Sets whether to allow clients to send keep-alive HTTP/ 2 PINGs even if there are no outstanding RPCs on the connection. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      permitKeepAliveWithoutCalls - 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: boolean 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 boolean type. Default: false Group: consumer
      Parameters:
      routeControlledStreamObserver - the value to set
      Returns:
      the dsl builder

    • authenticationType

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder authenticationType(org.apache.camel.component.grpc.GrpcAuthType authenticationType)
      Authentication method type in advance to the SSL/TLS negotiation. The option is a: org.apache.camel.component.grpc.GrpcAuthType type. Default: NONE Group: security
      Parameters:
      authenticationType - 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 org.apache.camel.component.grpc.GrpcAuthType type. Default: NONE Group: security
      Parameters:
      authenticationType - the value to set
      Returns:
      the dsl builder

    • jwtAlgorithm

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder jwtAlgorithm(org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm jwtAlgorithm)
      JSON Web Token sign algorithm. The option is a: org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm type. Default: HMAC256 Group: security
      Parameters:
      jwtAlgorithm - 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 org.apache.camel.component.grpc.auth.jwt.JwtAlgorithm type. Default: HMAC256 Group: security
      Parameters:
      jwtAlgorithm - the value to set
      Returns:
      the dsl builder

    • jwtIssuer

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder jwtIssuer(String jwtIssuer)
      JSON Web Token issuer. The option is a: java.lang.String type. Group: security
      Parameters:
      jwtIssuer - the value to set
      Returns:
      the dsl builder

    • jwtSecret

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder jwtSecret(String jwtSecret)
      JSON Web Token secret. The option is a: java.lang.String type. Group: security
      Parameters:
      jwtSecret - the value to set
      Returns:
      the dsl builder

    • jwtSubject

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder jwtSubject(String jwtSubject)
      JSON Web Token subject. The option is a: java.lang.String type. Group: security
      Parameters:
      jwtSubject - 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
      Parameters:
      keyCertChainResource - the value to set
      Returns:
      the dsl builder

    • keyPassword

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder keyPassword(String keyPassword)
      The PKCS#8 private key file password. The option is a: java.lang.String type. Group: security
      Parameters:
      keyPassword - 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
      Parameters:
      keyResource - the value to set
      Returns:
      the dsl builder

    • negotiationType

      default GrpcEndpointBuilderFactory.GrpcEndpointConsumerBuilder negotiationType(io.grpc.netty.NegotiationType negotiationType)
      Identifies the security negotiation type used for HTTP/2 communication. The option is a: io.grpc.netty.NegotiationType type. Default: PLAINTEXT Group: security
      Parameters:
      negotiationType - 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 io.grpc.netty.NegotiationType 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
      Parameters:
      trustCertCollectionResource - the value to set
      Returns:
      the dsl builder