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

Interface GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointBuilder
Enclosing interface:
GooglePubsubEndpointBuilderFactory
public static interface GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Google Pubsub component.

  • Method Details

    • basic

      default GooglePubsubEndpointBuilderFactory.GooglePubsubEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • concurrentConsumers

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder concurrentConsumers(Integer concurrentConsumers)
      The number of parallel streams consuming from the subscription. The option is a: java.lang.Integer type. Default: 1 Group: consumer (advanced)
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • concurrentConsumers

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder concurrentConsumers(String concurrentConsumers)
      The number of parallel streams consuming from the subscription. The option will be converted to a java.lang.Integer type. Default: 1 Group: consumer (advanced)
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • maxAckExtensionPeriod

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxAckExtensionPeriod(int maxAckExtensionPeriod)
      Set the maximum period a message ack deadline will be extended. Value in seconds. The option is a: int type. Default: 3600 Group: consumer (advanced)
      Parameters:
      maxAckExtensionPeriod - the value to set
      Returns:
      the dsl builder

    • maxAckExtensionPeriod

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxAckExtensionPeriod(String maxAckExtensionPeriod)
      Set the maximum period a message ack deadline will be extended. Value in seconds. The option will be converted to a int type. Default: 3600 Group: consumer (advanced)
      Parameters:
      maxAckExtensionPeriod - the value to set
      Returns:
      the dsl builder

    • maxDeliveryAttempts

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxDeliveryAttempts(int maxDeliveryAttempts)
      The maximum number of delivery attempts for each message. When set to a positive value, the consumer will automatically nack any message whose delivery attempt count is greater than or equal to this value, allowing Pub/Sub to route it to the dead-letter topic without processing it. This prevents infinite redelivery loops when short retry delays are configured. If not explicitly set and the subscription has a dead-letter policy, the value is automatically fetched from the subscription configuration at consumer startup. Set to 0 to disable enforcement. The option is a: int type. Default: 0 Group: consumer (advanced)
      Parameters:
      maxDeliveryAttempts - the value to set
      Returns:
      the dsl builder

    • maxDeliveryAttempts

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxDeliveryAttempts(String maxDeliveryAttempts)
      The maximum number of delivery attempts for each message. When set to a positive value, the consumer will automatically nack any message whose delivery attempt count is greater than or equal to this value, allowing Pub/Sub to route it to the dead-letter topic without processing it. This prevents infinite redelivery loops when short retry delays are configured. If not explicitly set and the subscription has a dead-letter policy, the value is automatically fetched from the subscription configuration at consumer startup. Set to 0 to disable enforcement. The option will be converted to a int type. Default: 0 Group: consumer (advanced)
      Parameters:
      maxDeliveryAttempts - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxMessagesPerPoll(Integer maxMessagesPerPoll)
      The max number of messages to receive from the server in a single API call. The option is a: java.lang.Integer type. Default: 1 Group: consumer (advanced)
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
      The max number of messages to receive from the server in a single API call. The option will be converted to a java.lang.Integer type. Default: 1 Group: consumer (advanced)
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • synchronousPull

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder synchronousPull(boolean synchronousPull)
      Synchronously pull batches of messages. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      synchronousPull - the value to set
      Returns:
      the dsl builder

    • synchronousPull

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder synchronousPull(String synchronousPull)
      Synchronously pull batches of messages. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      synchronousPull - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter headers to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter headers to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • includeAllGoogleProperties

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder includeAllGoogleProperties(boolean includeAllGoogleProperties)
      Whether to include all Google headers when mapping from Pubsub to Camel Message. Setting this to true will include properties such as x-goog etc. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      includeAllGoogleProperties - the value to set
      Returns:
      the dsl builder

    • includeAllGoogleProperties

      default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder includeAllGoogleProperties(String includeAllGoogleProperties)
      Whether to include all Google headers when mapping from Pubsub to Camel Message. Setting this to true will include properties such as x-goog etc. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      includeAllGoogleProperties - the value to set
      Returns:
      the dsl builder

    • loggerId

      @Deprecated default GooglePubsubEndpointBuilderFactory.AdvancedGooglePubsubEndpointConsumerBuilder loggerId(String loggerId)
      Deprecated.
      To use a custom logger name. The option is a: java.lang.String type. Group: advanced
      Parameters:
      loggerId - the value to set
      Returns:
      the dsl builder